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, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ Citus

Returns a new instance of Citus.



2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
# File 'lib/models/porcelain.rb', line 2871

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,
  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
  @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.



2841
2842
2843
# File 'lib/models/porcelain.rb', line 2841

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.



2843
2844
2845
# File 'lib/models/porcelain.rb', line 2843

def database
  @database
end

#egress_filterObject

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



2845
2846
2847
# File 'lib/models/porcelain.rb', line 2845

def egress_filter
  @egress_filter
end

#healthyObject

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



2847
2848
2849
# File 'lib/models/porcelain.rb', line 2847

def healthy
  @healthy
end

#hostnameObject

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



2849
2850
2851
# File 'lib/models/porcelain.rb', line 2849

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



2851
2852
2853
# File 'lib/models/porcelain.rb', line 2851

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



2853
2854
2855
# File 'lib/models/porcelain.rb', line 2853

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.



2855
2856
2857
# File 'lib/models/porcelain.rb', line 2855

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



2857
2858
2859
# File 'lib/models/porcelain.rb', line 2857

def password
  @password
end

#portObject

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



2859
2860
2861
# File 'lib/models/porcelain.rb', line 2859

def port
  @port
end

#port_overrideObject

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



2861
2862
2863
# File 'lib/models/porcelain.rb', line 2861

def port_override
  @port_override
end

#secret_store_idObject

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



2863
2864
2865
# File 'lib/models/porcelain.rb', line 2863

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)



2865
2866
2867
# File 'lib/models/porcelain.rb', line 2865

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



2867
2868
2869
# File 'lib/models/porcelain.rb', line 2867

def tags
  @tags
end

#usernameObject

The username to authenticate with.



2869
2870
2871
# File 'lib/models/porcelain.rb', line 2869

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



2905
2906
2907
2908
2909
2910
2911
# File 'lib/models/porcelain.rb', line 2905

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