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.



12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
# File 'lib/models/porcelain.rb', line 12306

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.



12274
12275
12276
# File 'lib/models/porcelain.rb', line 12274

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.



12276
12277
12278
# File 'lib/models/porcelain.rb', line 12276

def database
  @database
end

#egress_filterObject

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



12278
12279
12280
# File 'lib/models/porcelain.rb', line 12278

def egress_filter
  @egress_filter
end

#healthyObject

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



12280
12281
12282
# File 'lib/models/porcelain.rb', line 12280

def healthy
  @healthy
end

#hostnameObject

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



12282
12283
12284
# File 'lib/models/porcelain.rb', line 12282

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



12284
12285
12286
# File 'lib/models/porcelain.rb', line 12284

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



12286
12287
12288
# File 'lib/models/porcelain.rb', line 12286

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.



12288
12289
12290
# File 'lib/models/porcelain.rb', line 12288

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



12290
12291
12292
# File 'lib/models/porcelain.rb', line 12290

def password
  @password
end

#portObject

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



12292
12293
12294
# File 'lib/models/porcelain.rb', line 12292

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.



12294
12295
12296
# File 'lib/models/porcelain.rb', line 12294

def port_override
  @port_override
end

#proxy_cluster_idObject

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



12296
12297
12298
# File 'lib/models/porcelain.rb', line 12296

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



12298
12299
12300
# File 'lib/models/porcelain.rb', line 12298

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.



12300
12301
12302
# File 'lib/models/porcelain.rb', line 12300

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



12302
12303
12304
# File 'lib/models/porcelain.rb', line 12302

def tags
  @tags
end

#usernameObject

The username to authenticate with.



12304
12305
12306
# File 'lib/models/porcelain.rb', line 12304

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



12342
12343
12344
12345
12346
12347
12348
# File 'lib/models/porcelain.rb', line 12342

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