Class: SDM::ProxyCluster

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

ProxyCluster represents a cluster of StrongDM proxies.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address: nil, id: nil, maintenance_windows: nil, name: nil, tags: nil) ⇒ ProxyCluster

Returns a new instance of ProxyCluster.



8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
 
# File 'lib/models/porcelain.rb', line 8838

def initialize(
  address: nil,
  id: nil,
  maintenance_windows: nil,
  name: nil,
  tags: nil
)
  @address = address == nil ? "" : address
  @id = id == nil ? "" : id
  @maintenance_windows = maintenance_windows == nil ? [] : maintenance_windows
  @name = name == nil ? "" : name
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
end

Instance Attribute Details

#address ⇒ Object

The public hostname/port tuple at which the proxy cluster will be accessible to clients.



8815
8816
8817
 
# File 'lib/models/porcelain.rb', line 8815

def address
  @address
end

#id ⇒ Object

Unique identifier of the Proxy Cluster.



8817
8818
8819
 
# File 'lib/models/porcelain.rb', line 8817

def id
  @id
end

#maintenance_windows ⇒ Object

Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed.

If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0.

If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.



8830
8831
8832
 
# File 'lib/models/porcelain.rb', line 8830

def maintenance_windows
  @maintenance_windows
end

#name ⇒ Object

Unique human-readable name of the proxy cluster. Names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.



8834
8835
8836
 
# File 'lib/models/porcelain.rb', line 8834

def name
  @name
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8836
8837
8838
 
# File 'lib/models/porcelain.rb', line 8836

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8852
8853
8854
8855
8856
8857
8858
 
# File 'lib/models/porcelain.rb', line 8852

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