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.



13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
 
# File 'lib/models/porcelain.rb', line 13839

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.



13807
13808
13809
 
# File 'lib/models/porcelain.rb', line 13807

def device
  @device
end

#gateway_filter ⇒ Object

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



13810
13811
13812
 
# File 'lib/models/porcelain.rb', line 13810

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



13812
13813
13814
 
# File 'lib/models/porcelain.rb', line 13812

def id
  @id
end

#location ⇒ Object

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



13815
13816
13817
 
# File 'lib/models/porcelain.rb', line 13815

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.



13828
13829
13830
 
# File 'lib/models/porcelain.rb', line 13828

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.



13830
13831
13832
 
# File 'lib/models/porcelain.rb', line 13830

def name
  @name
end

#state ⇒ Object

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



13832
13833
13834
 
# File 'lib/models/porcelain.rb', line 13832

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



13834
13835
13836
 
# File 'lib/models/porcelain.rb', line 13834

def tags
  @tags
end

#version ⇒ Object

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



13837
13838
13839
 
# File 'lib/models/porcelain.rb', line 13837

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13861
13862
13863
13864
13865
13866
13867
 
# File 'lib/models/porcelain.rb', line 13861

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