Class: SDM::MCP

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

Overview

MCP is currently unstable, and its API may change, or it may be removed, without a major version bump.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(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) ⇒ MCP

Returns a new instance of MCP.



9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
 
# File 'lib/models/porcelain.rb', line 9240

def initialize(
  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
)
  @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

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



9212
9213
9214
 
# File 'lib/models/porcelain.rb', line 9212

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



9214
9215
9216
 
# File 'lib/models/porcelain.rb', line 9214

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



9216
9217
9218
 
# File 'lib/models/porcelain.rb', line 9216

def healthy
  @healthy
end

#hostname ⇒ Object

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



9218
9219
9220
 
# File 'lib/models/porcelain.rb', line 9218

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



9220
9221
9222
 
# File 'lib/models/porcelain.rb', line 9220

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



9222
9223
9224
 
# File 'lib/models/porcelain.rb', line 9222

def name
  @name
end

#password ⇒ Object

The password to authenticate with.



9224
9225
9226
 
# File 'lib/models/porcelain.rb', line 9224

def password
  @password
end

#port ⇒ Object

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



9226
9227
9228
 
# File 'lib/models/porcelain.rb', line 9226

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.



9228
9229
9230
 
# File 'lib/models/porcelain.rb', line 9228

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



9230
9231
9232
 
# File 'lib/models/porcelain.rb', line 9230

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



9232
9233
9234
 
# File 'lib/models/porcelain.rb', line 9232

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.



9234
9235
9236
 
# File 'lib/models/porcelain.rb', line 9234

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



9236
9237
9238
 
# File 'lib/models/porcelain.rb', line 9236

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



9238
9239
9240
 
# File 'lib/models/porcelain.rb', line 9238

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



9272
9273
9274
9275
9276
9277
9278
 
# File 'lib/models/porcelain.rb', line 9272

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