Google Cloud AlloyDB for PostgreSQL V1 Client - Class ConnectionInfo (1.1.0)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class ConnectionInfo.

ConnectionInfo singleton resource.

https://google.aip.dev/156

Generated from protobuf message google.cloud.alloydb.v1.ConnectionInfo

Namespace

Google \ Cloud \ AlloyDb \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

The name of the ConnectionInfo singleton resource, e.g.: projects/{project}/locations/{location}/clusters//instances//connectionInfo This field currently has no semantic meaning.

↳ ip_address string

Output only. The private network IP address for the Instance. This is the default IP for the instance and is always created (even if enable_public_ip is set). This is the connection endpoint for an end-user application.

↳ public_ip_address string

Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.

↳ instance_uid string

Output only. The unique ID of the Instance.

getName

The name of the ConnectionInfo singleton resource, e.g.: projects/{project}/locations/{location}/clusters//instances//connectionInfo This field currently has no semantic meaning.

Returns
Type Description
string

setName

The name of the ConnectionInfo singleton resource, e.g.: projects/{project}/locations/{location}/clusters//instances//connectionInfo This field currently has no semantic meaning.

Parameter
Name Description
var string
Returns
Type Description
$this

getIpAddress

Output only. The private network IP address for the Instance. This is the default IP for the instance and is always created (even if enable_public_ip is set). This is the connection endpoint for an end-user application.

Returns
Type Description
string

setIpAddress

Output only. The private network IP address for the Instance. This is the default IP for the instance and is always created (even if enable_public_ip is set). This is the connection endpoint for an end-user application.

Parameter
Name Description
var string
Returns
Type Description
$this

getPublicIpAddress

Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.

Returns
Type Description
string

setPublicIpAddress

Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.

Parameter
Name Description
var string
Returns
Type Description
$this

getInstanceUid

Output only. The unique ID of the Instance.

Returns
Type Description
string

setInstanceUid

Output only. The unique ID of the Instance.

Parameter
Name Description
var string
Returns
Type Description
$this