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, name: nil, state: nil, tags: nil, version: nil) ⇒ Relay

Returns a new instance of Relay.



6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'lib/models/porcelain.rb', line 6452

def initialize(
  device: nil,
  gateway_filter: nil,
  id: nil,
  location: 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
  @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

#deviceObject

Device is a read only device name uploaded by the gateway process when it comes online.



6431
6432
6433
# File 'lib/models/porcelain.rb', line 6431

def device
  @device
end

#gateway_filterObject

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



6434
6435
6436
# File 'lib/models/porcelain.rb', line 6434

def gateway_filter
  @gateway_filter
end

#idObject

Unique identifier of the Relay.



6436
6437
6438
# File 'lib/models/porcelain.rb', line 6436

def id
  @id
end

#locationObject

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



6439
6440
6441
# File 'lib/models/porcelain.rb', line 6439

def location
  @location
end

#nameObject

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.



6441
6442
6443
# File 'lib/models/porcelain.rb', line 6441

def name
  @name
end

#stateObject

The current state of the relay. One of: "new", "verifying_restart", "awaiting_restart", "restarting", "started", "stopped", "dead", "unknown".



6445
6446
6447
# File 'lib/models/porcelain.rb', line 6445

def state
  @state
end

#tagsObject

Tags is a map of key, value pairs.



6447
6448
6449
# File 'lib/models/porcelain.rb', line 6447

def tags
  @tags
end

#versionObject

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



6450
6451
6452
# File 'lib/models/porcelain.rb', line 6450

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6472
6473
6474
6475
6476
6477
6478
# File 'lib/models/porcelain.rb', line 6472

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