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.



6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
 
# File 'lib/models/porcelain.rb', line 6547

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.



6517
6518
6519
 
# File 'lib/models/porcelain.rb', line 6517

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.



6519
6520
6521
 
# File 'lib/models/porcelain.rb', line 6519

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



6521
6522
6523
 
# File 'lib/models/porcelain.rb', line 6521

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



6523
6524
6525
 
# File 'lib/models/porcelain.rb', line 6523

def healthy
  @healthy
end

#hostname ⇒ Object

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



6525
6526
6527
 
# File 'lib/models/porcelain.rb', line 6525

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



6527
6528
6529
 
# File 'lib/models/porcelain.rb', line 6527

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



6529
6530
6531
 
# File 'lib/models/porcelain.rb', line 6529

def name
  @name
end

#password ⇒ Object

The password to authenticate with.



6531
6532
6533
 
# File 'lib/models/porcelain.rb', line 6531

def password
  @password
end

#port ⇒ Object

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



6533
6534
6535
 
# File 'lib/models/porcelain.rb', line 6533

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.



6535
6536
6537
 
# File 'lib/models/porcelain.rb', line 6535

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



6537
6538
6539
 
# File 'lib/models/porcelain.rb', line 6537

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



6539
6540
6541
 
# File 'lib/models/porcelain.rb', line 6539

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.



6541
6542
6543
 
# File 'lib/models/porcelain.rb', line 6541

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



6543
6544
6545
 
# File 'lib/models/porcelain.rb', line 6543

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



6545
6546
6547
 
# File 'lib/models/porcelain.rb', line 6545

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



6581
6582
6583
6584
6585
6586
6587
 
# File 'lib/models/porcelain.rb', line 6581

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