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.



10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
 
# File 'lib/models/porcelain.rb', line 10096

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.



10064
10065
10066
 
# File 'lib/models/porcelain.rb', line 10064

def device
  @device
end

#gateway_filter ⇒ Object

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



10067
10068
10069
 
# File 'lib/models/porcelain.rb', line 10067

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



10069
10070
10071
 
# File 'lib/models/porcelain.rb', line 10069

def id
  @id
end

#location ⇒ Object

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



10072
10073
10074
 
# File 'lib/models/porcelain.rb', line 10072

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.



10085
10086
10087
 
# File 'lib/models/porcelain.rb', line 10085

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.



10087
10088
10089
 
# File 'lib/models/porcelain.rb', line 10087

def name
  @name
end

#state ⇒ Object

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



10089
10090
10091
 
# File 'lib/models/porcelain.rb', line 10089

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



10091
10092
10093
 
# File 'lib/models/porcelain.rb', line 10091

def tags
  @tags
end

#version ⇒ Object

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



10094
10095
10096
 
# File 'lib/models/porcelain.rb', line 10094

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



10118
10119
10120
10121
10122
10123
10124
 
# File 'lib/models/porcelain.rb', line 10118

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