Class: SDM::Relay

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

Overview

Relay represents a StrongDM CLI installation running in relay mode.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(device: nil, gateway_filter: nil, id: nil, location: nil, maintenance_windows: nil, name: nil, state: nil, tags: nil, version: nil) ⇒ Relay

Returns a new instance of Relay.



10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
 
# File 'lib/models/porcelain.rb', line 10629

def initialize(
  device: nil,
  gateway_filter: nil,
  id: nil,
  location: nil,
  maintenance_windows: nil,
  name: nil,
  state: nil,
  tags: nil,
  version: nil
)
  @device = device == nil ? "" : device
  @gateway_filter = gateway_filter == nil ? "" : gateway_filter
  @id = id == nil ? "" : id
  @location = location == nil ? "" : location
  @maintenance_windows = maintenance_windows == nil ? [] : maintenance_windows
  @name = name == nil ? "" : name
  @state = state == nil ? "" : state
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @version = version == nil ? "" : version
end

Instance Attribute Details

#device ⇒ Object

Device is a read only device name uploaded by the gateway process when it comes online.



10597
10598
10599
 
# File 'lib/models/porcelain.rb', line 10597

def device
  @device
end

#gateway_filter ⇒ Object

GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.



10600
10601
10602
 
# File 'lib/models/porcelain.rb', line 10600

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



10602
10603
10604
 
# File 'lib/models/porcelain.rb', line 10602

def id
  @id
end

#location ⇒ Object

Location is a read only network location uploaded by the gateway process when it comes online.



10605
10606
10607
 
# File 'lib/models/porcelain.rb', line 10605

def location
  @location
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.



10618
10619
10620
 
# File 'lib/models/porcelain.rb', line 10618

def maintenance_windows
  @maintenance_windows
end

#name ⇒ Object

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



10620
10621
10622
 
# File 'lib/models/porcelain.rb', line 10620

def name
  @name
end

#state ⇒ Object

The current state of the relay, one of the NodeState constants.



10622
10623
10624
 
# File 'lib/models/porcelain.rb', line 10622

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



10624
10625
10626
 
# File 'lib/models/porcelain.rb', line 10624

def tags
  @tags
end

#version ⇒ Object

Version is a read only sdm binary version uploaded by the gateway process when it comes online.



10627
10628
10629
 
# File 'lib/models/porcelain.rb', line 10627

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



10651
10652
10653
10654
10655
10656
10657
 
# File 'lib/models/porcelain.rb', line 10651

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