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.



5265
5266
5267
5268
5269
5270
5271
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
 
# File 'lib/models/porcelain.rb', line 5265

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_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.



5233
5234
5235
 
# File 'lib/models/porcelain.rb', line 5233

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



5235
5236
5237
 
# File 'lib/models/porcelain.rb', line 5235

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



5237
5238
5239
 
# File 'lib/models/porcelain.rb', line 5237

def healthy
  @healthy
end

#hostname ⇒ Object

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



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

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



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

def id
  @id
end

#n1ql_port ⇒ Object

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



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

def n1ql_port
  @n1ql_port
end

#name ⇒ Object

Unique human-readable name of the Resource.



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

def name
  @name
end

#password ⇒ Object

The password to authenticate with.



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

def password
  @password
end

#port ⇒ Object

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



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

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.



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

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



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

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



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

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.



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

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



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

def tags
  @tags
end

#tls_required ⇒ Object

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



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

def tls_required
  @tls_required
end

#username ⇒ Object

The username to authenticate with.



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

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



5301
5302
5303
5304
5305
5306
5307
 
# File 'lib/models/porcelain.rb', line 5301

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