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.



12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
 
# File 'lib/models/porcelain.rb', line 12170

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.



12138
12139
12140
 
# File 'lib/models/porcelain.rb', line 12138

def device
  @device
end

#gateway_filter ⇒ Object

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



12141
12142
12143
 
# File 'lib/models/porcelain.rb', line 12141

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



12143
12144
12145
 
# File 'lib/models/porcelain.rb', line 12143

def id
  @id
end

#location ⇒ Object

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



12146
12147
12148
 
# File 'lib/models/porcelain.rb', line 12146

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.



12159
12160
12161
 
# File 'lib/models/porcelain.rb', line 12159

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.



12161
12162
12163
 
# File 'lib/models/porcelain.rb', line 12161

def name
  @name
end

#state ⇒ Object

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



12163
12164
12165
 
# File 'lib/models/porcelain.rb', line 12163

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12165
12166
12167
 
# File 'lib/models/porcelain.rb', line 12165

def tags
  @tags
end

#version ⇒ Object

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



12168
12169
12170
 
# File 'lib/models/porcelain.rb', line 12168

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12192
12193
12194
12195
12196
12197
12198
 
# File 'lib/models/porcelain.rb', line 12192

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