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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string | |
setName
Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getView
Optional. The view of the cluster to return. Returns all default fields if not set.
| Returns | |
|---|---|
| Type | Description |
int | |
setView
Optional. The view of the cluster to return. Returns all default fields if not set.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
Google\Cloud\AlloyDb\V1\GetClusterRequest | |