Class: SDM::CouchbaseDatabase

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bind_interface: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, n1ql_port: nil, name: nil, password: nil, port: nil, port_override: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, tls_required: nil, username: nil) ⇒ CouchbaseDatabase

Returns a new instance of CouchbaseDatabase.



5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
# File 'lib/models/porcelain.rb', line 5021

def initialize(
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  n1ql_port: nil,
  name: nil,
  password: nil,
  port: nil,
  port_override: nil,
  proxy_cluster_id: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  tls_required: nil,
  username: nil
)
  @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
  @n1ql_port = n1ql_port == nil ? 0 : n1ql_port
  @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
  @tls_required = tls_required == nil ? false : tls_required
  @username = username == nil ? "" : username
end

Instance Attribute Details

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



4989
4990
4991
# File 'lib/models/porcelain.rb', line 4989

def bind_interface
  @bind_interface
end

#egress_filterObject

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



4991
4992
4993
# File 'lib/models/porcelain.rb', line 4991

def egress_filter
  @egress_filter
end

#healthyObject

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



4993
4994
4995
# File 'lib/models/porcelain.rb', line 4993

def healthy
  @healthy
end

#hostnameObject

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



4995
4996
4997
# File 'lib/models/porcelain.rb', line 4995

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



4997
4998
4999
# File 'lib/models/porcelain.rb', line 4997

def id
  @id
end

#n1ql_portObject

The port number for N1QL queries. Default HTTP is 8093. Default HTTPS is 18093.



4999
5000
5001
# File 'lib/models/porcelain.rb', line 4999

def n1ql_port
  @n1ql_port
end

#nameObject

Unique human-readable name of the Resource.



5001
5002
5003
# File 'lib/models/porcelain.rb', line 5001

def name
  @name
end

#passwordObject

The password to authenticate with.



5003
5004
5005
# File 'lib/models/porcelain.rb', line 5003

def password
  @password
end

#portObject

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



5005
5006
5007
# File 'lib/models/porcelain.rb', line 5005

def port
  @port
end

#port_overrideObject

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.



5007
5008
5009
# File 'lib/models/porcelain.rb', line 5007

def port_override
  @port_override
end

#proxy_cluster_idObject

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



5009
5010
5011
# File 'lib/models/porcelain.rb', line 5009

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



5011
5012
5013
# File 'lib/models/porcelain.rb', line 5011

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)



5013
5014
5015
# File 'lib/models/porcelain.rb', line 5013

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5015
5016
5017
# File 'lib/models/porcelain.rb', line 5015

def tags
  @tags
end

#tls_requiredObject

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



5017
5018
5019
# File 'lib/models/porcelain.rb', line 5017

def tls_required
  @tls_required
end

#usernameObject

The username to authenticate with.



5019
5020
5021
# File 'lib/models/porcelain.rb', line 5019

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5057
5058
5059
5060
5061
5062
5063
# File 'lib/models/porcelain.rb', line 5057

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