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.



13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
 
# File 'lib/models/porcelain.rb', line 13498

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.



13475
13476
13477
 
# File 'lib/models/porcelain.rb', line 13475

def address
  @address
end

#id ⇒ Object

Unique identifier of the Proxy Cluster.



13477
13478
13479
 
# File 'lib/models/porcelain.rb', line 13477

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.



13490
13491
13492
 
# File 'lib/models/porcelain.rb', line 13490

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.



13494
13495
13496
 
# File 'lib/models/porcelain.rb', line 13494

def name
  @name
end

#tags ⇒ Object

Tags is a map of key, value pairs.



13496
13497
13498
 
# File 'lib/models/porcelain.rb', line 13496

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13512
13513
13514
13515
13516
13517
13518
 
# File 'lib/models/porcelain.rb', line 13512

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