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.



8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
 
# File 'lib/models/porcelain.rb', line 8940

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.



8908
8909
8910
 
# File 'lib/models/porcelain.rb', line 8908

def device
  @device
end

#gateway_filter ⇒ Object

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



8911
8912
8913
 
# File 'lib/models/porcelain.rb', line 8911

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



8913
8914
8915
 
# File 'lib/models/porcelain.rb', line 8913

def id
  @id
end

#location ⇒ Object

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



8916
8917
8918
 
# File 'lib/models/porcelain.rb', line 8916

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.



8929
8930
8931
 
# File 'lib/models/porcelain.rb', line 8929

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.



8931
8932
8933
 
# File 'lib/models/porcelain.rb', line 8931

def name
  @name
end

#state ⇒ Object

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



8933
8934
8935
 
# File 'lib/models/porcelain.rb', line 8933

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8935
8936
8937
 
# File 'lib/models/porcelain.rb', line 8935

def tags
  @tags
end

#version ⇒ Object

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



8938
8939
8940
 
# File 'lib/models/porcelain.rb', line 8938

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8962
8963
8964
8965
8966
8967
8968
 
# File 'lib/models/porcelain.rb', line 8962

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