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.



14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
 
# File 'lib/models/porcelain.rb', line 14315

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.



14283
14284
14285
 
# File 'lib/models/porcelain.rb', line 14283

def device
  @device
end

#gateway_filter ⇒ Object

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



14286
14287
14288
 
# File 'lib/models/porcelain.rb', line 14286

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



14288
14289
14290
 
# File 'lib/models/porcelain.rb', line 14288

def id
  @id
end

#location ⇒ Object

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



14291
14292
14293
 
# File 'lib/models/porcelain.rb', line 14291

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.



14304
14305
14306
 
# File 'lib/models/porcelain.rb', line 14304

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.



14306
14307
14308
 
# File 'lib/models/porcelain.rb', line 14306

def name
  @name
end

#state ⇒ Object

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



14308
14309
14310
 
# File 'lib/models/porcelain.rb', line 14308

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14310
14311
14312
 
# File 'lib/models/porcelain.rb', line 14310

def tags
  @tags
end

#version ⇒ Object

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



14313
14314
14315
 
# File 'lib/models/porcelain.rb', line 14313

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14337
14338
14339
14340
14341
14342
14343
 
# File 'lib/models/porcelain.rb', line 14337

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