Class: SDM::RDP

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, downgrade_nla_connections: nil, egress_filter: nil, healthy: nil, hostname: nil, 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.



11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
# File 'lib/models/porcelain.rb', line 11132

def initialize(
  bind_interface: nil,
  downgrade_nla_connections: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  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
  @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_interfaceObject

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.



11100
11101
11102
# File 'lib/models/porcelain.rb', line 11100

def bind_interface
  @bind_interface
end

#downgrade_nla_connectionsObject

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.



11102
11103
11104
# File 'lib/models/porcelain.rb', line 11102

def downgrade_nla_connections
  @downgrade_nla_connections
end

#egress_filterObject

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



11104
11105
11106
# File 'lib/models/porcelain.rb', line 11104

def egress_filter
  @egress_filter
end

#healthyObject

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



11106
11107
11108
# File 'lib/models/porcelain.rb', line 11106

def healthy
  @healthy
end

#hostnameObject

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



11108
11109
11110
# File 'lib/models/porcelain.rb', line 11108

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



11110
11111
11112
# File 'lib/models/porcelain.rb', line 11110

def id
  @id
end

#lock_requiredObject

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



11112
11113
11114
# File 'lib/models/porcelain.rb', line 11112

def lock_required
  @lock_required
end

#nameObject

Unique human-readable name of the Resource.



11114
11115
11116
# File 'lib/models/porcelain.rb', line 11114

def name
  @name
end

#passwordObject

The password to authenticate with.



11116
11117
11118
# File 'lib/models/porcelain.rb', line 11116

def password
  @password
end

#portObject

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



11118
11119
11120
# File 'lib/models/porcelain.rb', line 11118

def port
  @port
end

#port_overrideObject

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



11120
11121
11122
# File 'lib/models/porcelain.rb', line 11120

def port_override
  @port_override
end

#proxy_cluster_idObject

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



11122
11123
11124
# File 'lib/models/porcelain.rb', line 11122

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



11124
11125
11126
# File 'lib/models/porcelain.rb', line 11124

def secret_store_id
  @secret_store_id
end

#subdomainObject

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



11126
11127
11128
# File 'lib/models/porcelain.rb', line 11126

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



11128
11129
11130
# File 'lib/models/porcelain.rb', line 11128

def tags
  @tags
end

#usernameObject

The username to authenticate with.



11130
11131
11132
# File 'lib/models/porcelain.rb', line 11130

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



11168
11169
11170
11171
11172
11173
11174
# File 'lib/models/porcelain.rb', line 11168

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