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.



12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
 
# File 'lib/models/porcelain.rb', line 12278

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.



12246
12247
12248
 
# File 'lib/models/porcelain.rb', line 12246

def device
  @device
end

#gateway_filter ⇒ Object

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



12249
12250
12251
 
# File 'lib/models/porcelain.rb', line 12249

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



12251
12252
12253
 
# File 'lib/models/porcelain.rb', line 12251

def id
  @id
end

#location ⇒ Object

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



12254
12255
12256
 
# File 'lib/models/porcelain.rb', line 12254

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.



12267
12268
12269
 
# File 'lib/models/porcelain.rb', line 12267

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.



12269
12270
12271
 
# File 'lib/models/porcelain.rb', line 12269

def name
  @name
end

#state ⇒ Object

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



12271
12272
12273
 
# File 'lib/models/porcelain.rb', line 12271

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12273
12274
12275
 
# File 'lib/models/porcelain.rb', line 12273

def tags
  @tags
end

#version ⇒ Object

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



12276
12277
12278
 
# File 'lib/models/porcelain.rb', line 12276

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12300
12301
12302
12303
12304
12305
12306
 
# File 'lib/models/porcelain.rb', line 12300

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