Class: SDM::DocumentDBHost

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

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, username: nil) ⇒ DocumentDBHost

Returns a new instance of DocumentDBHost.



3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
# File 'lib/models/porcelain.rb', line 3455

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,
  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
  @username = username == nil ? "" : username
end

Instance Attribute Details

#auth_databaseObject

The authentication database to use.



3427
3428
3429
# File 'lib/models/porcelain.rb', line 3427

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.



3429
3430
3431
# File 'lib/models/porcelain.rb', line 3429

def bind_interface
  @bind_interface
end

#egress_filterObject

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



3431
3432
3433
# File 'lib/models/porcelain.rb', line 3431

def egress_filter
  @egress_filter
end

#healthyObject

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



3433
3434
3435
# File 'lib/models/porcelain.rb', line 3433

def healthy
  @healthy
end

#hostnameObject

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



3435
3436
3437
# File 'lib/models/porcelain.rb', line 3435

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



3437
3438
3439
# File 'lib/models/porcelain.rb', line 3437

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



3439
3440
3441
# File 'lib/models/porcelain.rb', line 3439

def name
  @name
end

#passwordObject

The password to authenticate with.



3441
3442
3443
# File 'lib/models/porcelain.rb', line 3441

def password
  @password
end

#portObject

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



3443
3444
3445
# File 'lib/models/porcelain.rb', line 3443

def port
  @port
end

#port_overrideObject

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



3445
3446
3447
# File 'lib/models/porcelain.rb', line 3445

def port_override
  @port_override
end

#secret_store_idObject

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



3447
3448
3449
# File 'lib/models/porcelain.rb', line 3447

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)



3449
3450
3451
# File 'lib/models/porcelain.rb', line 3449

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



3451
3452
3453
# File 'lib/models/porcelain.rb', line 3451

def tags
  @tags
end

#usernameObject

The username to authenticate with.



3453
3454
3455
# File 'lib/models/porcelain.rb', line 3453

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



3487
3488
3489
3490
3491
3492
3493
# File 'lib/models/porcelain.rb', line 3487

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