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.



5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
# File 'lib/models/porcelain.rb', line 5272

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.



5240
5241
5242
# File 'lib/models/porcelain.rb', line 5240

def bind_interface
  @bind_interface
end

#egress_filterObject

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



5242
5243
5244
# File 'lib/models/porcelain.rb', line 5242

def egress_filter
  @egress_filter
end

#healthyObject

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



5244
5245
5246
# File 'lib/models/porcelain.rb', line 5244

def healthy
  @healthy
end

#hostnameObject

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



5246
5247
5248
# File 'lib/models/porcelain.rb', line 5246

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5248
5249
5250
# File 'lib/models/porcelain.rb', line 5248

def id
  @id
end

#n1ql_portObject

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



5250
5251
5252
# File 'lib/models/porcelain.rb', line 5250

def n1ql_port
  @n1ql_port
end

#nameObject

Unique human-readable name of the Resource.



5252
5253
5254
# File 'lib/models/porcelain.rb', line 5252

def name
  @name
end

#passwordObject

The password to authenticate with.



5254
5255
5256
# File 'lib/models/porcelain.rb', line 5254

def password
  @password
end

#portObject

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



5256
5257
5258
# File 'lib/models/porcelain.rb', line 5256

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.



5258
5259
5260
# File 'lib/models/porcelain.rb', line 5258

def port_override
  @port_override
end

#proxy_cluster_idObject

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



5260
5261
5262
# File 'lib/models/porcelain.rb', line 5260

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



5262
5263
5264
# File 'lib/models/porcelain.rb', line 5262

def secret_store_id
  @secret_store_id
end

#subdomainObject

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.



5264
5265
5266
# File 'lib/models/porcelain.rb', line 5264

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5266
5267
5268
# File 'lib/models/porcelain.rb', line 5266

def tags
  @tags
end

#tls_requiredObject

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



5268
5269
5270
# File 'lib/models/porcelain.rb', line 5268

def tls_required
  @tls_required
end

#usernameObject

The username to authenticate with.



5270
5271
5272
# File 'lib/models/porcelain.rb', line 5270

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5308
5309
5310
5311
5312
5313
5314
# File 'lib/models/porcelain.rb', line 5308

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