Class: SDM::ClickHouseTCP

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, password: nil, port: nil, port_override: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, tls_required: nil, username: nil) ⇒ ClickHouseTCP

Returns a new instance of ClickHouseTCP.



4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
# File 'lib/models/porcelain.rb', line 4936

def initialize(
  bind_interface: nil,
  database: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  name: nil,
  password: nil,
  port: nil,
  port_override: nil,
  proxy_cluster_id: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  tls_required: 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
  @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
  @tls_required = tls_required == nil ? false : tls_required
  @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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



4904
4905
4906
# File 'lib/models/porcelain.rb', line 4904

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.



4906
4907
4908
# File 'lib/models/porcelain.rb', line 4906

def database
  @database
end

#egress_filterObject

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



4908
4909
4910
# File 'lib/models/porcelain.rb', line 4908

def egress_filter
  @egress_filter
end

#healthyObject

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



4910
4911
4912
# File 'lib/models/porcelain.rb', line 4910

def healthy
  @healthy
end

#hostnameObject

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



4912
4913
4914
# File 'lib/models/porcelain.rb', line 4912

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



4914
4915
4916
# File 'lib/models/porcelain.rb', line 4914

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



4916
4917
4918
# File 'lib/models/porcelain.rb', line 4916

def name
  @name
end

#passwordObject

The password to authenticate with.



4918
4919
4920
# File 'lib/models/porcelain.rb', line 4918

def password
  @password
end

#portObject

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



4920
4921
4922
# File 'lib/models/porcelain.rb', line 4920

def port
  @port
end

#port_overrideObject

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



4922
4923
4924
# File 'lib/models/porcelain.rb', line 4922

def port_override
  @port_override
end

#proxy_cluster_idObject

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



4924
4925
4926
# File 'lib/models/porcelain.rb', line 4924

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



4926
4927
4928
# File 'lib/models/porcelain.rb', line 4926

def secret_store_id
  @secret_store_id
end

#subdomainObject

DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.



4928
4929
4930
# File 'lib/models/porcelain.rb', line 4928

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



4930
4931
4932
# File 'lib/models/porcelain.rb', line 4930

def tags
  @tags
end

#tls_requiredObject

If set, TLS must be used to connect to this resource.



4932
4933
4934
# File 'lib/models/porcelain.rb', line 4932

def tls_required
  @tls_required
end

#usernameObject

The username to authenticate with.



4934
4935
4936
# File 'lib/models/porcelain.rb', line 4934

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



4972
4973
4974
4975
4976
4977
4978
# File 'lib/models/porcelain.rb', line 4972

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