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.



9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
 
# File 'lib/models/porcelain.rb', line 9723

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.



9695
9696
9697
 
# File 'lib/models/porcelain.rb', line 9695

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



9697
9698
9699
 
# File 'lib/models/porcelain.rb', line 9697

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



9699
9700
9701
 
# File 'lib/models/porcelain.rb', line 9699

def healthy
  @healthy
end

#hostname ⇒ Object

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



9701
9702
9703
 
# File 'lib/models/porcelain.rb', line 9701

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



9703
9704
9705
 
# File 'lib/models/porcelain.rb', line 9703

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



9705
9706
9707
 
# File 'lib/models/porcelain.rb', line 9705

def name
  @name
end

#password ⇒ Object

OAuth App Client Secret



9707
9708
9709
 
# File 'lib/models/porcelain.rb', line 9707

def password
  @password
end

#port ⇒ Object

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



9709
9710
9711
 
# File 'lib/models/porcelain.rb', line 9709

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.



9711
9712
9713
 
# File 'lib/models/porcelain.rb', line 9711

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



9713
9714
9715
 
# File 'lib/models/porcelain.rb', line 9713

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



9715
9716
9717
 
# File 'lib/models/porcelain.rb', line 9715

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.



9717
9718
9719
 
# File 'lib/models/porcelain.rb', line 9717

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



9719
9720
9721
 
# File 'lib/models/porcelain.rb', line 9719

def tags
  @tags
end

#username ⇒ Object

OAuth App Client ID



9721
9722
9723
 
# File 'lib/models/porcelain.rb', line 9721

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



9755
9756
9757
9758
9759
9760
9761
 
# File 'lib/models/porcelain.rb', line 9755

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