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.



10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
 
# File 'lib/models/porcelain.rb', line 10776

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.



10744
10745
10746
 
# File 'lib/models/porcelain.rb', line 10744

def device
  @device
end

#gateway_filter ⇒ Object

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



10747
10748
10749
 
# File 'lib/models/porcelain.rb', line 10747

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



10749
10750
10751
 
# File 'lib/models/porcelain.rb', line 10749

def id
  @id
end

#location ⇒ Object

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



10752
10753
10754
 
# File 'lib/models/porcelain.rb', line 10752

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.



10765
10766
10767
 
# File 'lib/models/porcelain.rb', line 10765

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.



10767
10768
10769
 
# File 'lib/models/porcelain.rb', line 10767

def name
  @name
end

#state ⇒ Object

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



10769
10770
10771
 
# File 'lib/models/porcelain.rb', line 10769

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



10771
10772
10773
 
# File 'lib/models/porcelain.rb', line 10771

def tags
  @tags
end

#version ⇒ Object

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



10774
10775
10776
 
# File 'lib/models/porcelain.rb', line 10774

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



10798
10799
10800
10801
10802
10803
10804
 
# File 'lib/models/porcelain.rb', line 10798

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