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.



13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
 
# File 'lib/models/porcelain.rb', line 13480

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.



13448
13449
13450
 
# File 'lib/models/porcelain.rb', line 13448

def device
  @device
end

#gateway_filter ⇒ Object

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



13451
13452
13453
 
# File 'lib/models/porcelain.rb', line 13451

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



13453
13454
13455
 
# File 'lib/models/porcelain.rb', line 13453

def id
  @id
end

#location ⇒ Object

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



13456
13457
13458
 
# File 'lib/models/porcelain.rb', line 13456

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.



13469
13470
13471
 
# File 'lib/models/porcelain.rb', line 13469

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.



13471
13472
13473
 
# File 'lib/models/porcelain.rb', line 13471

def name
  @name
end

#state ⇒ Object

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



13473
13474
13475
 
# File 'lib/models/porcelain.rb', line 13473

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



13475
13476
13477
 
# File 'lib/models/porcelain.rb', line 13475

def tags
  @tags
end

#version ⇒ Object

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



13478
13479
13480
 
# File 'lib/models/porcelain.rb', line 13478

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13502
13503
13504
13505
13506
13507
13508
 
# File 'lib/models/porcelain.rb', line 13502

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