Class: SDM::Postgres

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

Returns a new instance of Postgres.



7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
# File 'lib/models/porcelain.rb', line 7894

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.



7864
7865
7866
# File 'lib/models/porcelain.rb', line 7864

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.



7866
7867
7868
# File 'lib/models/porcelain.rb', line 7866

def database
  @database
end

#egress_filterObject

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



7868
7869
7870
# File 'lib/models/porcelain.rb', line 7868

def egress_filter
  @egress_filter
end

#healthyObject

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



7870
7871
7872
# File 'lib/models/porcelain.rb', line 7870

def healthy
  @healthy
end

#hostnameObject

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



7872
7873
7874
# File 'lib/models/porcelain.rb', line 7872

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



7874
7875
7876
# File 'lib/models/porcelain.rb', line 7874

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



7876
7877
7878
# File 'lib/models/porcelain.rb', line 7876

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.



7878
7879
7880
# File 'lib/models/porcelain.rb', line 7878

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



7880
7881
7882
# File 'lib/models/porcelain.rb', line 7880

def password
  @password
end

#portObject

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



7882
7883
7884
# File 'lib/models/porcelain.rb', line 7882

def port
  @port
end

#port_overrideObject

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



7884
7885
7886
# File 'lib/models/porcelain.rb', line 7884

def port_override
  @port_override
end

#secret_store_idObject

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



7886
7887
7888
# File 'lib/models/porcelain.rb', line 7886

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)



7888
7889
7890
# File 'lib/models/porcelain.rb', line 7888

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



7890
7891
7892
# File 'lib/models/porcelain.rb', line 7890

def tags
  @tags
end

#usernameObject

The username to authenticate with.



7892
7893
7894
# File 'lib/models/porcelain.rb', line 7892

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



7928
7929
7930
7931
7932
7933
7934
# File 'lib/models/porcelain.rb', line 7928

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