Google Cloud AlloyDB for PostgreSQL V1 Client - Class ListClustersRequest (1.0.0)

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

Message for requesting list of Clusters

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

Namespace

Google \ Cloud \ AlloyDb \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/-

↳ page_size int

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

↳ page_token string

A token identifying a page of results the server should return.

↳ filter string

Optional. Filtering results

↳ order_by string

Optional. Hint for how to order the results

getParent

Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format:

  • projects/{project}/locations/-
Returns
Type Description
string

setParent

Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format:

  • projects/{project}/locations/-
Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Returns
Type Description
int

setPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A token identifying a page of results the server should return.

Returns
Type Description
string

setPageToken

A token identifying a page of results the server should return.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Filtering results

Returns
Type Description
string

setFilter

Optional. Filtering results

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Hint for how to order the results

Returns
Type Description
string

setOrderBy

Optional. Hint for how to order the results

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format:

  • projects/{project}/locations/- Please see Google\Cloud\AlloyDb\V1\AlloyDBAdminClient::locationName() for help formatting this field.
Returns
Type Description
Google\Cloud\AlloyDb\V1\ListClustersRequest