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

Returns a new instance of Postgres.



13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
# File 'lib/models/porcelain.rb', line 13353

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



13321
13322
13323
# File 'lib/models/porcelain.rb', line 13321

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.



13323
13324
13325
# File 'lib/models/porcelain.rb', line 13323

def database
  @database
end

#egress_filterObject

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



13325
13326
13327
# File 'lib/models/porcelain.rb', line 13325

def egress_filter
  @egress_filter
end

#healthyObject

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



13327
13328
13329
# File 'lib/models/porcelain.rb', line 13327

def healthy
  @healthy
end

#hostnameObject

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



13329
13330
13331
# File 'lib/models/porcelain.rb', line 13329

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



13331
13332
13333
# File 'lib/models/porcelain.rb', line 13331

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



13333
13334
13335
# File 'lib/models/porcelain.rb', line 13333

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.



13335
13336
13337
# File 'lib/models/porcelain.rb', line 13335

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



13337
13338
13339
# File 'lib/models/porcelain.rb', line 13337

def password
  @password
end

#portObject

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



13339
13340
13341
# File 'lib/models/porcelain.rb', line 13339

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.



13341
13342
13343
# File 'lib/models/porcelain.rb', line 13341

def port_override
  @port_override
end

#proxy_cluster_idObject

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



13343
13344
13345
# File 'lib/models/porcelain.rb', line 13343

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



13345
13346
13347
# File 'lib/models/porcelain.rb', line 13345

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.



13347
13348
13349
# File 'lib/models/porcelain.rb', line 13347

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



13349
13350
13351
# File 'lib/models/porcelain.rb', line 13349

def tags
  @tags
end

#usernameObject

The username to authenticate with.



13351
13352
13353
# File 'lib/models/porcelain.rb', line 13351

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



13389
13390
13391
13392
13393
13394
13395
# File 'lib/models/porcelain.rb', line 13389

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