Google Cloud AlloyDB for PostgreSQL V1 Client - Class GetClusterRequest (0.4.0)

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

Message for getting a Cluster

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

Namespace

Google \ Cloud \ AlloyDb \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

↳ view int

Optional. The view of the cluster to return. Returns all default fields if not set.

getName

Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

Returns
TypeDescription
string

setName

Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getView

Optional. The view of the cluster to return. Returns all default fields if not set.

Returns
TypeDescription
int

setView

Optional. The view of the cluster to return. Returns all default fields if not set.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. The name of the resource. For the required format, see the comment on the Cluster.name field. Please see Google\Cloud\AlloyDb\V1\AlloyDBAdminClient::clusterName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\AlloyDb\V1\GetClusterRequest