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.



14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838
14839
14840
14841
14842
 
# File 'lib/models/porcelain.rb', line 14822

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.



14790
14791
14792
 
# File 'lib/models/porcelain.rb', line 14790

def device
  @device
end

#gateway_filter ⇒ Object

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



14793
14794
14795
 
# File 'lib/models/porcelain.rb', line 14793

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



14795
14796
14797
 
# File 'lib/models/porcelain.rb', line 14795

def id
  @id
end

#location ⇒ Object

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



14798
14799
14800
 
# File 'lib/models/porcelain.rb', line 14798

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.



14811
14812
14813
 
# File 'lib/models/porcelain.rb', line 14811

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.



14813
14814
14815
 
# File 'lib/models/porcelain.rb', line 14813

def name
  @name
end

#state ⇒ Object

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



14815
14816
14817
 
# File 'lib/models/porcelain.rb', line 14815

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14817
14818
14819
 
# File 'lib/models/porcelain.rb', line 14817

def tags
  @tags
end

#version ⇒ Object

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



14820
14821
14822
 
# File 'lib/models/porcelain.rb', line 14820

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14844
14845
14846
14847
14848
14849
14850
 
# File 'lib/models/porcelain.rb', line 14844

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