Class: SDM::Cockroach

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bind_interface: nil, database: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, name: nil, override_database: nil, password: nil, port: nil, port_override: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ Cockroach

Returns a new instance of Cockroach.



4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
# File 'lib/models/porcelain.rb', line 4694

def initialize(
  bind_interface: nil,
  database: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  name: nil,
  override_database: nil,
  password: nil,
  port: nil,
  port_override: nil,
  proxy_cluster_id: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  username: nil
)
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @database = database == nil ? "" : database
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @name = name == nil ? "" : name
  @override_database = override_database == nil ? false : override_database
  @password = password == nil ? "" : password
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @username = username == nil ? "" : username
end

Instance Attribute Details

#bind_interfaceObject

The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.



4662
4663
4664
# File 'lib/models/porcelain.rb', line 4662

def bind_interface
  @bind_interface
end

#databaseObject

The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.



4664
4665
4666
# File 'lib/models/porcelain.rb', line 4664

def database
  @database
end

#egress_filterObject

A filter applied to the routing logic to pin datasource to nodes.



4666
4667
4668
# File 'lib/models/porcelain.rb', line 4666

def egress_filter
  @egress_filter
end

#healthyObject

True if the datasource is reachable and the credentials are valid.



4668
4669
4670
# File 'lib/models/porcelain.rb', line 4668

def healthy
  @healthy
end

#hostnameObject

The host to dial to initiate a connection from the egress node to this resource.



4670
4671
4672
# File 'lib/models/porcelain.rb', line 4670

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



4672
4673
4674
# File 'lib/models/porcelain.rb', line 4672

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



4674
4675
4676
# File 'lib/models/porcelain.rb', line 4674

def name
  @name
end

#override_databaseObject

If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.



4676
4677
4678
# File 'lib/models/porcelain.rb', line 4676

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



4678
4679
4680
# File 'lib/models/porcelain.rb', line 4678

def password
  @password
end

#portObject

The port to dial to initiate a connection from the egress node to this resource.



4680
4681
4682
# File 'lib/models/porcelain.rb', line 4680

def port
  @port
end

#port_overrideObject

The local port used by clients to connect to this resource.



4682
4683
4684
# File 'lib/models/porcelain.rb', line 4682

def port_override
  @port_override
end

#proxy_cluster_idObject

ID of the proxy cluster for this resource, if any.



4684
4685
4686
# File 'lib/models/porcelain.rb', line 4684

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

ID of the secret store containing credentials for this resource, if any.



4686
4687
4688
# File 'lib/models/porcelain.rb', line 4686

def secret_store_id
  @secret_store_id
end

#subdomainObject

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



4688
4689
4690
# File 'lib/models/porcelain.rb', line 4688

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



4690
4691
4692
# File 'lib/models/porcelain.rb', line 4690

def tags
  @tags
end

#usernameObject

The username to authenticate with.



4692
4693
4694
# File 'lib/models/porcelain.rb', line 4692

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



4730
4731
4732
4733
4734
4735
4736
# File 'lib/models/porcelain.rb', line 4730

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