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.



14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
 
# File 'lib/models/porcelain.rb', line 14232

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.



14200
14201
14202
 
# File 'lib/models/porcelain.rb', line 14200

def device
  @device
end

#gateway_filter ⇒ Object

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



14203
14204
14205
 
# File 'lib/models/porcelain.rb', line 14203

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Relay.



14205
14206
14207
 
# File 'lib/models/porcelain.rb', line 14205

def id
  @id
end

#location ⇒ Object

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



14208
14209
14210
 
# File 'lib/models/porcelain.rb', line 14208

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.



14221
14222
14223
 
# File 'lib/models/porcelain.rb', line 14221

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.



14223
14224
14225
 
# File 'lib/models/porcelain.rb', line 14223

def name
  @name
end

#state ⇒ Object

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



14225
14226
14227
 
# File 'lib/models/porcelain.rb', line 14225

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14227
14228
14229
 
# File 'lib/models/porcelain.rb', line 14227

def tags
  @tags
end

#version ⇒ Object

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



14230
14231
14232
 
# File 'lib/models/porcelain.rb', line 14230

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14254
14255
14256
14257
14258
14259
14260
 
# File 'lib/models/porcelain.rb', line 14254

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