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.



11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
 
# File 'lib/models/porcelain.rb', line 11309

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.



11286
11287
11288
 
# File 'lib/models/porcelain.rb', line 11286

def address
  @address
end

#id ⇒ Object

Unique identifier of the Proxy Cluster.



11288
11289
11290
 
# File 'lib/models/porcelain.rb', line 11288

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.



11301
11302
11303
 
# File 'lib/models/porcelain.rb', line 11301

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.



11305
11306
11307
 
# File 'lib/models/porcelain.rb', line 11305

def name
  @name
end

#tags ⇒ Object

Tags is a map of key, value pairs.



11307
11308
11309
 
# File 'lib/models/porcelain.rb', line 11307

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11323
11324
11325
11326
11327
11328
11329
 
# File 'lib/models/porcelain.rb', line 11323

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