Google Cloud AlloyDB for PostgreSQL V1 Client - Class Node (0.5.0)

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

Details of a single node in the instance.

Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.

Generated from protobuf message google.cloud.alloydb.v1.Instance.Node

Namespace

Google \ Cloud \ AlloyDb \ V1 \ Instance

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ zone_id string

The Compute Engine zone of the VM e.g. "us-central1-b".

↳ id string

The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".

↳ ip string

The private IP address of the VM e.g. "10.57.0.34".

↳ state string

Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.

getZoneId

The Compute Engine zone of the VM e.g. "us-central1-b".

Returns
TypeDescription
string

setZoneId

The Compute Engine zone of the VM e.g. "us-central1-b".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getId

The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".

Returns
TypeDescription
string

setId

The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIp

The private IP address of the VM e.g. "10.57.0.34".

Returns
TypeDescription
string

setIp

The private IP address of the VM e.g. "10.57.0.34".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Determined by state of the compute VM and postgres-service health.

Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.

Returns
TypeDescription
string

setState

Determined by state of the compute VM and postgres-service health.

Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.

Parameter
NameDescription
var string
Returns
TypeDescription
$this