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.



5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
# File 'lib/models/porcelain.rb', line 5508

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.



5478
5479
5480
# File 'lib/models/porcelain.rb', line 5478

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.



5480
5481
5482
# File 'lib/models/porcelain.rb', line 5480

def bind_interface
  @bind_interface
end

#egress_filterObject

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



5482
5483
5484
# File 'lib/models/porcelain.rb', line 5482

def egress_filter
  @egress_filter
end

#healthyObject

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



5484
5485
5486
# File 'lib/models/porcelain.rb', line 5484

def healthy
  @healthy
end

#hostnameObject

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



5486
5487
5488
# File 'lib/models/porcelain.rb', line 5486

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5488
5489
5490
# File 'lib/models/porcelain.rb', line 5488

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5490
5491
5492
# File 'lib/models/porcelain.rb', line 5490

def name
  @name
end

#passwordObject

The password to authenticate with.



5492
5493
5494
# File 'lib/models/porcelain.rb', line 5492

def password
  @password
end

#portObject

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



5494
5495
5496
# File 'lib/models/porcelain.rb', line 5494

def port
  @port
end

#port_overrideObject

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



5496
5497
5498
# File 'lib/models/porcelain.rb', line 5496

def port_override
  @port_override
end

#secret_store_idObject

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



5498
5499
5500
# File 'lib/models/porcelain.rb', line 5498

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)



5500
5501
5502
# File 'lib/models/porcelain.rb', line 5500

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5502
5503
5504
# File 'lib/models/porcelain.rb', line 5502

def tags
  @tags
end

#tls_requiredObject

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



5504
5505
5506
# File 'lib/models/porcelain.rb', line 5504

def tls_required
  @tls_required
end

#usernameObject

The username to authenticate with.



5506
5507
5508
# File 'lib/models/porcelain.rb', line 5506

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5542
5543
5544
5545
5546
5547
5548
# File 'lib/models/porcelain.rb', line 5542

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