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.



13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
 
# File 'lib/models/porcelain.rb', line 13767

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.



13735
13736
13737
 
# File 'lib/models/porcelain.rb', line 13735

def device
  @device
end

#gateway_filter ⇒ Object

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



13738
13739
13740
 
# File 'lib/models/porcelain.rb', line 13738

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



13740
13741
13742
 
# File 'lib/models/porcelain.rb', line 13740

def id
  @id
end

#location ⇒ Object

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



13743
13744
13745
 
# File 'lib/models/porcelain.rb', line 13743

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.



13756
13757
13758
 
# File 'lib/models/porcelain.rb', line 13756

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.



13758
13759
13760
 
# File 'lib/models/porcelain.rb', line 13758

def name
  @name
end

#state ⇒ Object

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



13760
13761
13762
 
# File 'lib/models/porcelain.rb', line 13760

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



13762
13763
13764
 
# File 'lib/models/porcelain.rb', line 13762

def tags
  @tags
end

#version ⇒ Object

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



13765
13766
13767
 
# File 'lib/models/porcelain.rb', line 13765

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13789
13790
13791
13792
13793
13794
13795
 
# File 'lib/models/porcelain.rb', line 13789

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