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.



12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
# File 'lib/models/porcelain.rb', line 12719

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.



12687
12688
12689
# File 'lib/models/porcelain.rb', line 12687

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.



12689
12690
12691
# File 'lib/models/porcelain.rb', line 12689

def downgrade_nla_connections
  @downgrade_nla_connections
end

#egress_filterObject

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



12691
12692
12693
# File 'lib/models/porcelain.rb', line 12691

def egress_filter
  @egress_filter
end

#healthyObject

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



12693
12694
12695
# File 'lib/models/porcelain.rb', line 12693

def healthy
  @healthy
end

#hostnameObject

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



12695
12696
12697
# File 'lib/models/porcelain.rb', line 12695

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



12697
12698
12699
# File 'lib/models/porcelain.rb', line 12697

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.



12699
12700
12701
# File 'lib/models/porcelain.rb', line 12699

def lock_required
  @lock_required
end

#nameObject

Unique human-readable name of the Resource.



12701
12702
12703
# File 'lib/models/porcelain.rb', line 12701

def name
  @name
end

#passwordObject

The password to authenticate with.



12703
12704
12705
# File 'lib/models/porcelain.rb', line 12703

def password
  @password
end

#portObject

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



12705
12706
12707
# File 'lib/models/porcelain.rb', line 12705

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.



12707
12708
12709
# File 'lib/models/porcelain.rb', line 12707

def port_override
  @port_override
end

#proxy_cluster_idObject

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



12709
12710
12711
# File 'lib/models/porcelain.rb', line 12709

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



12711
12712
12713
# File 'lib/models/porcelain.rb', line 12711

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.



12713
12714
12715
# File 'lib/models/porcelain.rb', line 12713

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



12715
12716
12717
# File 'lib/models/porcelain.rb', line 12715

def tags
  @tags
end

#usernameObject

The username to authenticate with.



12717
12718
12719
# File 'lib/models/porcelain.rb', line 12717

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



12755
12756
12757
12758
12759
12760
12761
# File 'lib/models/porcelain.rb', line 12755

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