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.



6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
# File 'lib/models/porcelain.rb', line 6055

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.



6025
6026
6027
# File 'lib/models/porcelain.rb', line 6025

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.



6027
6028
6029
# File 'lib/models/porcelain.rb', line 6027

def bind_interface
  @bind_interface
end

#egress_filterObject

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



6029
6030
6031
# File 'lib/models/porcelain.rb', line 6029

def egress_filter
  @egress_filter
end

#healthyObject

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



6031
6032
6033
# File 'lib/models/porcelain.rb', line 6031

def healthy
  @healthy
end

#hostnameObject

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



6033
6034
6035
# File 'lib/models/porcelain.rb', line 6033

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



6035
6036
6037
# File 'lib/models/porcelain.rb', line 6035

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



6037
6038
6039
# File 'lib/models/porcelain.rb', line 6037

def name
  @name
end

#passwordObject

The password to authenticate with.



6039
6040
6041
# File 'lib/models/porcelain.rb', line 6039

def password
  @password
end

#portObject

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



6041
6042
6043
# File 'lib/models/porcelain.rb', line 6041

def port
  @port
end

#port_overrideObject

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



6043
6044
6045
# File 'lib/models/porcelain.rb', line 6043

def port_override
  @port_override
end

#secret_store_idObject

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



6045
6046
6047
# File 'lib/models/porcelain.rb', line 6045

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)



6047
6048
6049
# File 'lib/models/porcelain.rb', line 6047

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



6049
6050
6051
# File 'lib/models/porcelain.rb', line 6049

def tags
  @tags
end

#tls_requiredObject

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



6051
6052
6053
# File 'lib/models/porcelain.rb', line 6051

def tls_required
  @tls_required
end

#usernameObject

The username to authenticate with.



6053
6054
6055
# File 'lib/models/porcelain.rb', line 6053

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6089
6090
6091
6092
6093
6094
6095
# File 'lib/models/porcelain.rb', line 6089

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