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.



6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
# File 'lib/models/porcelain.rb', line 6603

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.



6573
6574
6575
# File 'lib/models/porcelain.rb', line 6573

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.



6575
6576
6577
# File 'lib/models/porcelain.rb', line 6575

def bind_interface
  @bind_interface
end

#egress_filterObject

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



6577
6578
6579
# File 'lib/models/porcelain.rb', line 6577

def egress_filter
  @egress_filter
end

#healthyObject

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



6579
6580
6581
# File 'lib/models/porcelain.rb', line 6579

def healthy
  @healthy
end

#hostnameObject

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



6581
6582
6583
# File 'lib/models/porcelain.rb', line 6581

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



6583
6584
6585
# File 'lib/models/porcelain.rb', line 6583

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



6585
6586
6587
# File 'lib/models/porcelain.rb', line 6585

def name
  @name
end

#passwordObject

The password to authenticate with.



6587
6588
6589
# File 'lib/models/porcelain.rb', line 6587

def password
  @password
end

#portObject

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



6589
6590
6591
# File 'lib/models/porcelain.rb', line 6589

def port
  @port
end

#port_overrideObject

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



6591
6592
6593
# File 'lib/models/porcelain.rb', line 6591

def port_override
  @port_override
end

#secret_store_idObject

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



6593
6594
6595
# File 'lib/models/porcelain.rb', line 6593

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)



6595
6596
6597
# File 'lib/models/porcelain.rb', line 6595

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



6597
6598
6599
# File 'lib/models/porcelain.rb', line 6597

def tags
  @tags
end

#tls_requiredObject

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



6599
6600
6601
# File 'lib/models/porcelain.rb', line 6599

def tls_required
  @tls_required
end

#usernameObject

The username to authenticate with.



6601
6602
6603
# File 'lib/models/porcelain.rb', line 6601

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6637
6638
6639
6640
6641
6642
6643
# File 'lib/models/porcelain.rb', line 6637

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