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.



3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/models/porcelain.rb', line 3809

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.



3777
3778
3779
# File 'lib/models/porcelain.rb', line 3777

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.



3779
3780
3781
# File 'lib/models/porcelain.rb', line 3779

def database
  @database
end

#egress_filterObject

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



3781
3782
3783
# File 'lib/models/porcelain.rb', line 3781

def egress_filter
  @egress_filter
end

#healthyObject

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



3783
3784
3785
# File 'lib/models/porcelain.rb', line 3783

def healthy
  @healthy
end

#hostnameObject

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



3785
3786
3787
# File 'lib/models/porcelain.rb', line 3785

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



3787
3788
3789
# File 'lib/models/porcelain.rb', line 3787

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



3789
3790
3791
# File 'lib/models/porcelain.rb', line 3789

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.



3791
3792
3793
# File 'lib/models/porcelain.rb', line 3791

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



3793
3794
3795
# File 'lib/models/porcelain.rb', line 3793

def password
  @password
end

#portObject

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



3795
3796
3797
# File 'lib/models/porcelain.rb', line 3795

def port
  @port
end

#port_overrideObject

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



3797
3798
3799
# File 'lib/models/porcelain.rb', line 3797

def port_override
  @port_override
end

#proxy_cluster_idObject

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



3799
3800
3801
# File 'lib/models/porcelain.rb', line 3799

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



3801
3802
3803
# File 'lib/models/porcelain.rb', line 3801

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)



3803
3804
3805
# File 'lib/models/porcelain.rb', line 3803

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



3805
3806
3807
# File 'lib/models/porcelain.rb', line 3805

def tags
  @tags
end

#usernameObject

The username to authenticate with.



3807
3808
3809
# File 'lib/models/porcelain.rb', line 3807

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



3845
3846
3847
3848
3849
3850
3851
# File 'lib/models/porcelain.rb', line 3845

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