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.



11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
 
# File 'lib/models/porcelain.rb', line 11067

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.



11044
11045
11046
 
# File 'lib/models/porcelain.rb', line 11044

def address
  @address
end

#id ⇒ Object

Unique identifier of the Proxy Cluster.



11046
11047
11048
 
# File 'lib/models/porcelain.rb', line 11046

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.



11059
11060
11061
 
# File 'lib/models/porcelain.rb', line 11059

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.



11063
11064
11065
 
# File 'lib/models/porcelain.rb', line 11063

def name
  @name
end

#tags ⇒ Object

Tags is a map of key, value pairs.



11065
11066
11067
 
# File 'lib/models/porcelain.rb', line 11065

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11081
11082
11083
11084
11085
11086
11087
 
# File 'lib/models/porcelain.rb', line 11081

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