Class: SDM::RDP

Inherits:

Object

• Object
• SDM::RDP

Defined in:

lib/models/porcelain.rb

Instance Attribute Summary

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

• #downgrade_nla_connections ⇒ Object

  When set, network level authentication will not be used.

• #egress_filter ⇒ Object

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

• #healthy ⇒ Object

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

• #hostname ⇒ Object

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

• #id ⇒ Object

  Unique identifier of the Resource.

• #identity_alias_healthcheck_username ⇒ Object

  The username to use for healthchecks, when clients otherwise connect with their own identity alias username.

• #identity_set_id ⇒ Object

  if provided use identity_set to map username to secret store path.

• #lock_required ⇒ Object

  When set, require a resource lock to access the resource to ensure it can only be used by one user at a time.

• #name ⇒ Object

  Unique human-readable name of the Resource.

• #password ⇒ Object

  The password to authenticate with.

• #port ⇒ Object

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

• #port_override ⇒ Object

  The local port used by clients to connect to this resource.

• #proxy_cluster_id ⇒ Object

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

• #secret_store_id ⇒ Object

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

• #subdomain ⇒ Object

  DNS subdomain through which this resource may be accessed on clients.

• #tags ⇒ Object

  Tags is a map of key, value pairs.

• #username ⇒ Object

  The username to authenticate with.

Instance Method Summary

• #initialize(bind_interface: nil, downgrade_nla_connections: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, identity_alias_healthcheck_username: nil, identity_set_id: nil, lock_required: nil, name: nil, password: nil, port: nil, port_override: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ RDP constructor

  A new instance of RDP.

• #to_json(options = {}) ⇒ Object

Constructor Details

#initialize(bind_interface: nil, downgrade_nla_connections: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, identity_alias_healthcheck_username: nil, identity_set_id: nil, lock_required: nil, name: nil, password: nil, port: nil, port_override: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ RDP

Returns a new instance of RDP.

# File 'lib/models/porcelain.rb', line 13922

def initialize(
  bind_interface: nil,
  downgrade_nla_connections: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  identity_alias_healthcheck_username: nil,
  identity_set_id: nil,
  lock_required: 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
  @downgrade_nla_connections = downgrade_nla_connections == nil ? false : downgrade_nla_connections
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @identity_alias_healthcheck_username = identity_alias_healthcheck_username == nil ? "" : identity_alias_healthcheck_username
  @identity_set_id = identity_set_id == nil ? "" : identity_set_id
  @lock_required = lock_required == nil ? false : lock_required
  @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.

# File 'lib/models/porcelain.rb', line 13886

def bind_interface
  @bind_interface
end

#downgrade_nla_connections ⇒ Object

When set, network level authentication will not be used. May resolve unexpected authentication errors to older servers. When set, healthchecks cannot detect if a provided username / password pair is correct.

# File 'lib/models/porcelain.rb', line 13888

def downgrade_nla_connections
  @downgrade_nla_connections
end

#egress_filter ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13890

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13892

def healthy
  @healthy
end

#hostname ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13894

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.

# File 'lib/models/porcelain.rb', line 13896

def id
  @id
end

#identity_alias_healthcheck_username ⇒ Object

The username to use for healthchecks, when clients otherwise connect with their own identity alias username.

# File 'lib/models/porcelain.rb', line 13898

def identity_alias_healthcheck_username
  @identity_alias_healthcheck_username
end

#identity_set_id ⇒ Object

if provided use identity_set to map username to secret store path

# File 'lib/models/porcelain.rb', line 13900

def identity_set_id
  @identity_set_id
end

#lock_required ⇒ Object

When set, require a resource lock to access the resource to ensure it can only be used by one user at a time.

# File 'lib/models/porcelain.rb', line 13902

def lock_required
  @lock_required
end

#name ⇒ Object

Unique human-readable name of the Resource.

# File 'lib/models/porcelain.rb', line 13904

def name
  @name
end

#password ⇒ Object

The password to authenticate with.

# File 'lib/models/porcelain.rb', line 13906

def password
  @password
end

#port ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13908

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.

# File 'lib/models/porcelain.rb', line 13910

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13912

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13914

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.

# File 'lib/models/porcelain.rb', line 13916

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.

# File 'lib/models/porcelain.rb', line 13918

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.

# File 'lib/models/porcelain.rb', line 13920

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object

# File 'lib/models/porcelain.rb', line 13962

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