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.



12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
# File 'lib/models/porcelain.rb', line 12826

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



12794
12795
12796
# File 'lib/models/porcelain.rb', line 12794

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.



12796
12797
12798
# File 'lib/models/porcelain.rb', line 12796

def downgrade_nla_connections
  @downgrade_nla_connections
end

#egress_filterObject

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



12798
12799
12800
# File 'lib/models/porcelain.rb', line 12798

def egress_filter
  @egress_filter
end

#healthyObject

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



12800
12801
12802
# File 'lib/models/porcelain.rb', line 12800

def healthy
  @healthy
end

#hostnameObject

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



12802
12803
12804
# File 'lib/models/porcelain.rb', line 12802

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



12804
12805
12806
# File 'lib/models/porcelain.rb', line 12804

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.



12806
12807
12808
# File 'lib/models/porcelain.rb', line 12806

def lock_required
  @lock_required
end

#nameObject

Unique human-readable name of the Resource.



12808
12809
12810
# File 'lib/models/porcelain.rb', line 12808

def name
  @name
end

#passwordObject

The password to authenticate with.



12810
12811
12812
# File 'lib/models/porcelain.rb', line 12810

def password
  @password
end

#portObject

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



12812
12813
12814
# File 'lib/models/porcelain.rb', line 12812

def port
  @port
end

#port_overrideObject

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.



12814
12815
12816
# File 'lib/models/porcelain.rb', line 12814

def port_override
  @port_override
end

#proxy_cluster_idObject

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



12816
12817
12818
# File 'lib/models/porcelain.rb', line 12816

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



12818
12819
12820
# File 'lib/models/porcelain.rb', line 12818

def secret_store_id
  @secret_store_id
end

#subdomainObject

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.



12820
12821
12822
# File 'lib/models/porcelain.rb', line 12820

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



12822
12823
12824
# File 'lib/models/porcelain.rb', line 12822

def tags
  @tags
end

#usernameObject

The username to authenticate with.



12824
12825
12826
# File 'lib/models/porcelain.rb', line 12824

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



12862
12863
12864
12865
12866
12867
12868
# File 'lib/models/porcelain.rb', line 12862

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