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.



5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
 
# File 'lib/models/porcelain.rb', line 5720

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.



5690
5691
5692
 
# File 'lib/models/porcelain.rb', line 5690

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.



5692
5693
5694
 
# File 'lib/models/porcelain.rb', line 5692

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



5694
5695
5696
 
# File 'lib/models/porcelain.rb', line 5694

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



5696
5697
5698
 
# File 'lib/models/porcelain.rb', line 5696

def healthy
  @healthy
end

#hostname ⇒ Object

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



5698
5699
5700
 
# File 'lib/models/porcelain.rb', line 5698

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



5700
5701
5702
 
# File 'lib/models/porcelain.rb', line 5700

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



5702
5703
5704
 
# File 'lib/models/porcelain.rb', line 5702

def name
  @name
end

#password ⇒ Object

The password to authenticate with.



5704
5705
5706
 
# File 'lib/models/porcelain.rb', line 5704

def password
  @password
end

#port ⇒ Object

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



5706
5707
5708
 
# File 'lib/models/porcelain.rb', line 5706

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.



5708
5709
5710
 
# File 'lib/models/porcelain.rb', line 5708

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



5710
5711
5712
 
# File 'lib/models/porcelain.rb', line 5710

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



5712
5713
5714
 
# File 'lib/models/porcelain.rb', line 5712

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.



5714
5715
5716
 
# File 'lib/models/porcelain.rb', line 5714

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



5716
5717
5718
 
# File 'lib/models/porcelain.rb', line 5716

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



5718
5719
5720
 
# File 'lib/models/porcelain.rb', line 5718

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



5754
5755
5756
5757
5758
5759
5760
 
# File 'lib/models/porcelain.rb', line 5754

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