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.



12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
 
# File 'lib/models/porcelain.rb', line 12997

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.



12974
12975
12976
 
# File 'lib/models/porcelain.rb', line 12974

def address
  @address
end

#id ⇒ Object

Unique identifier of the Proxy Cluster.



12976
12977
12978
 
# File 'lib/models/porcelain.rb', line 12976

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.



12989
12990
12991
 
# File 'lib/models/porcelain.rb', line 12989

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.



12993
12994
12995
 
# File 'lib/models/porcelain.rb', line 12993

def name
  @name
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12995
12996
12997
 
# File 'lib/models/porcelain.rb', line 12995

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13011
13012
13013
13014
13015
13016
13017
 
# File 'lib/models/porcelain.rb', line 13011

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