Class: SDM::MongoHost

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

MongoHost is currently unstable, and its API may change, or it may be removed, without a major version bump.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auth_database: nil, bind_interface: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, name: nil, password: nil, port: nil, port_override: nil, secret_store_id: nil, subdomain: nil, tags: nil, tls_required: nil, username: nil) ⇒ MongoHost

Returns a new instance of MongoHost.



6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
# File 'lib/models/porcelain.rb', line 6202

def initialize(
  auth_database: nil,
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  name: nil,
  password: nil,
  port: nil,
  port_override: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  tls_required: nil,
  username: nil
)
  @auth_database = auth_database == nil ? "" : auth_database
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @name = name == nil ? "" : name
  @password = password == nil ? "" : password
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @tls_required = tls_required == nil ? false : tls_required
  @username = username == nil ? "" : username
end

Instance Attribute Details

#auth_databaseObject

The authentication database to use.



6172
6173
6174
# File 'lib/models/porcelain.rb', line 6172

def auth_database
  @auth_database
end

#bind_interfaceObject

The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.



6174
6175
6176
# File 'lib/models/porcelain.rb', line 6174

def bind_interface
  @bind_interface
end

#egress_filterObject

A filter applied to the routing logic to pin datasource to nodes.



6176
6177
6178
# File 'lib/models/porcelain.rb', line 6176

def egress_filter
  @egress_filter
end

#healthyObject

True if the datasource is reachable and the credentials are valid.



6178
6179
6180
# File 'lib/models/porcelain.rb', line 6178

def healthy
  @healthy
end

#hostnameObject

The host to dial to initiate a connection from the egress node to this resource.



6180
6181
6182
# File 'lib/models/porcelain.rb', line 6180

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



6182
6183
6184
# File 'lib/models/porcelain.rb', line 6182

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



6184
6185
6186
# File 'lib/models/porcelain.rb', line 6184

def name
  @name
end

#passwordObject

The password to authenticate with.



6186
6187
6188
# File 'lib/models/porcelain.rb', line 6186

def password
  @password
end

#portObject

The port to dial to initiate a connection from the egress node to this resource.



6188
6189
6190
# File 'lib/models/porcelain.rb', line 6188

def port
  @port
end

#port_overrideObject

The local port used by clients to connect to this resource.



6190
6191
6192
# File 'lib/models/porcelain.rb', line 6190

def port_override
  @port_override
end

#secret_store_idObject

ID of the secret store containing credentials for this resource, if any.



6192
6193
6194
# File 'lib/models/porcelain.rb', line 6192

def secret_store_id
  @secret_store_id
end

#subdomainObject

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



6194
6195
6196
# File 'lib/models/porcelain.rb', line 6194

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



6196
6197
6198
# File 'lib/models/porcelain.rb', line 6196

def tags
  @tags
end

#tls_requiredObject

If set, TLS must be used to connect to this resource.



6198
6199
6200
# File 'lib/models/porcelain.rb', line 6198

def tls_required
  @tls_required
end

#usernameObject

The username to authenticate with.



6200
6201
6202
# File 'lib/models/porcelain.rb', line 6200

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6236
6237
6238
6239
6240
6241
6242
# File 'lib/models/porcelain.rb', line 6236

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end