Class: SDM::Gateway

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

Gateway represents a StrongDM CLI installation running in gateway mode.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bind_address: nil, gateway_filter: nil, id: nil, listen_address: nil, name: nil, state: nil, tags: nil) ⇒ Gateway

Returns a new instance of Gateway.



2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'lib/models/porcelain.rb', line 2562

def initialize(
  bind_address: nil,
  gateway_filter: nil,
  id: nil,
  listen_address: nil,
  name: nil,
  state: nil,
  tags: nil
)
  @bind_address = bind_address == nil ? "" : bind_address
  @gateway_filter = gateway_filter == nil ? "" : gateway_filter
  @id = id == nil ? "" : id
  @listen_address = listen_address == nil ? "" : listen_address
  @name = name == nil ? "" : name
  @state = state == nil ? "" : state
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
end

Instance Attribute Details

#bind_address ⇒ Object

The hostname/port tuple which the gateway daemon will bind to. If not provided on create, set to "0.0.0.0:listen_address_port".



2546
2547
2548
 
# File 'lib/models/porcelain.rb', line 2546

def bind_address
  @bind_address
end

#gateway_filter ⇒ Object

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



2549
2550
2551
 
# File 'lib/models/porcelain.rb', line 2549

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Gateway.



2551
2552
2553
 
# File 'lib/models/porcelain.rb', line 2551

def id
  @id
end

#listen_address ⇒ Object

The public hostname/port tuple at which the gateway will be accessible to clients.



2553
2554
2555
 
# File 'lib/models/porcelain.rb', line 2553

def listen_address
  @listen_address
end

#name ⇒ Object

Unique human-readable name of the Gateway. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.



2555
2556
2557
 
# File 'lib/models/porcelain.rb', line 2555

def name
  @name
end

#state ⇒ Object

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



2558
2559
2560
 
# File 'lib/models/porcelain.rb', line 2558

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



2560
2561
2562
 
# File 'lib/models/porcelain.rb', line 2560

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



2580
2581
2582
2583
2584
2585
2586
 
# File 'lib/models/porcelain.rb', line 2580

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