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, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ DocumentDBHost

Returns a new instance of DocumentDBHost.



6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
 
# File 'lib/models/porcelain.rb', line 6511

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,
  proxy_cluster_id: 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
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @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_database ⇒ Object

The authentication database to use.



6481
6482
6483
 
# File 'lib/models/porcelain.rb', line 6481

def auth_database
  @auth_database
end

#bind_interface ⇒ Object

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



6483
6484
6485
 
# File 'lib/models/porcelain.rb', line 6483

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



6485
6486
6487
 
# File 'lib/models/porcelain.rb', line 6485

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



6487
6488
6489
 
# File 'lib/models/porcelain.rb', line 6487

def healthy
  @healthy
end

#hostname ⇒ Object

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



6489
6490
6491
 
# File 'lib/models/porcelain.rb', line 6489

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



6491
6492
6493
 
# File 'lib/models/porcelain.rb', line 6491

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



6493
6494
6495
 
# File 'lib/models/porcelain.rb', line 6493

def name
  @name
end

#password ⇒ Object

The password to authenticate with.



6495
6496
6497
 
# File 'lib/models/porcelain.rb', line 6495

def password
  @password
end

#port ⇒ Object

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



6497
6498
6499
 
# File 'lib/models/porcelain.rb', line 6497

def port
  @port
end

#port_override ⇒ Object

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



6499
6500
6501
 
# File 'lib/models/porcelain.rb', line 6499

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

ID of the proxy cluster for this resource, if any.



6501
6502
6503
 
# File 'lib/models/porcelain.rb', line 6501

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



6503
6504
6505
 
# File 'lib/models/porcelain.rb', line 6503

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.



6505
6506
6507
 
# File 'lib/models/porcelain.rb', line 6505

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



6507
6508
6509
 
# File 'lib/models/porcelain.rb', line 6507

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



6509
6510
6511
 
# File 'lib/models/porcelain.rb', line 6509

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



6545
6546
6547
6548
6549
6550
6551
 
# File 'lib/models/porcelain.rb', line 6545

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