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.



4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
# File 'lib/models/porcelain.rb', line 4855

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.



4823
4824
4825
# File 'lib/models/porcelain.rb', line 4823

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.



4825
4826
4827
# File 'lib/models/porcelain.rb', line 4825

def database
  @database
end

#egress_filterObject

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



4827
4828
4829
# File 'lib/models/porcelain.rb', line 4827

def egress_filter
  @egress_filter
end

#healthyObject

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



4829
4830
4831
# File 'lib/models/porcelain.rb', line 4829

def healthy
  @healthy
end

#hostnameObject

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



4831
4832
4833
# File 'lib/models/porcelain.rb', line 4831

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



4833
4834
4835
# File 'lib/models/porcelain.rb', line 4833

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



4835
4836
4837
# File 'lib/models/porcelain.rb', line 4835

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.



4837
4838
4839
# File 'lib/models/porcelain.rb', line 4837

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



4839
4840
4841
# File 'lib/models/porcelain.rb', line 4839

def password
  @password
end

#portObject

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



4841
4842
4843
# File 'lib/models/porcelain.rb', line 4841

def port
  @port
end

#port_overrideObject

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



4843
4844
4845
# File 'lib/models/porcelain.rb', line 4843

def port_override
  @port_override
end

#proxy_cluster_idObject

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



4845
4846
4847
# File 'lib/models/porcelain.rb', line 4845

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



4847
4848
4849
# File 'lib/models/porcelain.rb', line 4847

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)



4849
4850
4851
# File 'lib/models/porcelain.rb', line 4849

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



4851
4852
4853
# File 'lib/models/porcelain.rb', line 4851

def tags
  @tags
end

#usernameObject

The username to authenticate with.



4853
4854
4855
# File 'lib/models/porcelain.rb', line 4853

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



4891
4892
4893
4894
4895
4896
4897
# File 'lib/models/porcelain.rb', line 4891

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