Class: SDM::Citus

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) ⇒ Citus

Returns a new instance of Citus.

[View source]

3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
# File 'lib/models/porcelain.rb', line 3898

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.


3866
3867
3868
# File 'lib/models/porcelain.rb', line 3866

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.


3868
3869
3870
# File 'lib/models/porcelain.rb', line 3868

def database
  @database
end

#egress_filterObject

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


3870
3871
3872
# File 'lib/models/porcelain.rb', line 3870

def egress_filter
  @egress_filter
end

#healthyObject

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


3872
3873
3874
# File 'lib/models/porcelain.rb', line 3872

def healthy
  @healthy
end

#hostnameObject

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


3874
3875
3876
# File 'lib/models/porcelain.rb', line 3874

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.


3876
3877
3878
# File 'lib/models/porcelain.rb', line 3876

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.


3878
3879
3880
# File 'lib/models/porcelain.rb', line 3878

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.


3880
3881
3882
# File 'lib/models/porcelain.rb', line 3880

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.


3882
3883
3884
# File 'lib/models/porcelain.rb', line 3882

def password
  @password
end

#portObject

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


3884
3885
3886
# File 'lib/models/porcelain.rb', line 3884

def port
  @port
end

#port_overrideObject

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


3886
3887
3888
# File 'lib/models/porcelain.rb', line 3886

def port_override
  @port_override
end

#proxy_cluster_idObject

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


3888
3889
3890
# File 'lib/models/porcelain.rb', line 3888

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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


3890
3891
3892
# File 'lib/models/porcelain.rb', line 3890

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)


3892
3893
3894
# File 'lib/models/porcelain.rb', line 3892

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.


3894
3895
3896
# File 'lib/models/porcelain.rb', line 3894

def tags
  @tags
end

#usernameObject

The username to authenticate with.


3896
3897
3898
# File 'lib/models/porcelain.rb', line 3896

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object

[View source]

3934
3935
3936
3937
3938
3939
3940
# File 'lib/models/porcelain.rb', line 3934

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