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.



12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
 
# File 'lib/models/porcelain.rb', line 12359

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.



12327
12328
12329
 
# File 'lib/models/porcelain.rb', line 12327

def device
  @device
end

#gateway_filter ⇒ Object

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



12330
12331
12332
 
# File 'lib/models/porcelain.rb', line 12330

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



12332
12333
12334
 
# File 'lib/models/porcelain.rb', line 12332

def id
  @id
end

#location ⇒ Object

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



12335
12336
12337
 
# File 'lib/models/porcelain.rb', line 12335

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.



12348
12349
12350
 
# File 'lib/models/porcelain.rb', line 12348

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.



12350
12351
12352
 
# File 'lib/models/porcelain.rb', line 12350

def name
  @name
end

#state ⇒ Object

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



12352
12353
12354
 
# File 'lib/models/porcelain.rb', line 12352

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12354
12355
12356
 
# File 'lib/models/porcelain.rb', line 12354

def tags
  @tags
end

#version ⇒ Object

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



12357
12358
12359
 
# File 'lib/models/porcelain.rb', line 12357

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12381
12382
12383
12384
12385
12386
12387
 
# File 'lib/models/porcelain.rb', line 12381

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