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, oauth_auth_endpoint: nil, oauth_token_endpoint: nil, password: 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.



10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
 
# File 'lib/models/porcelain.rb', line 10154

def initialize(
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  name: nil,
  oauth_auth_endpoint: nil,
  oauth_token_endpoint: nil,
  password: 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
  @oauth_auth_endpoint = oauth_auth_endpoint == nil ? "" : oauth_auth_endpoint
  @oauth_token_endpoint = oauth_token_endpoint == nil ? "" : oauth_token_endpoint
  @password = password == nil ? "" : password
  @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.



10124
10125
10126
 
# File 'lib/models/porcelain.rb', line 10124

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



10126
10127
10128
 
# File 'lib/models/porcelain.rb', line 10126

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



10128
10129
10130
 
# File 'lib/models/porcelain.rb', line 10128

def healthy
  @healthy
end

#hostname ⇒ Object

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



10130
10131
10132
 
# File 'lib/models/porcelain.rb', line 10130

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



10132
10133
10134
 
# File 'lib/models/porcelain.rb', line 10132

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



10134
10135
10136
 
# File 'lib/models/porcelain.rb', line 10134

def name
  @name
end

#oauth_auth_endpoint ⇒ Object

The OAuth 2.0 authorization endpoint URL.



10136
10137
10138
 
# File 'lib/models/porcelain.rb', line 10136

def oauth_auth_endpoint
  @oauth_auth_endpoint
end

#oauth_token_endpoint ⇒ Object

The OAuth 2.0 token endpoint URL.



10138
10139
10140
 
# File 'lib/models/porcelain.rb', line 10138

def oauth_token_endpoint
  @oauth_token_endpoint
end

#password ⇒ Object

OAuth App Client Secret



10140
10141
10142
 
# File 'lib/models/porcelain.rb', line 10140

def password
  @password
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.



10142
10143
10144
 
# File 'lib/models/porcelain.rb', line 10142

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



10144
10145
10146
 
# File 'lib/models/porcelain.rb', line 10144

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



10146
10147
10148
 
# File 'lib/models/porcelain.rb', line 10146

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.



10148
10149
10150
 
# File 'lib/models/porcelain.rb', line 10148

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



10150
10151
10152
 
# File 'lib/models/porcelain.rb', line 10150

def tags
  @tags
end

#username ⇒ Object

OAuth App Client ID



10152
10153
10154
 
# File 'lib/models/porcelain.rb', line 10152

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



10188
10189
10190
10191
10192
10193
10194
 
# File 'lib/models/porcelain.rb', line 10188

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