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

Version 1.1.0

• 1.1.1 (latest)
• 1.1.0
• 1.0.0
• 0.10.3
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.3

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

Message for requesting list of Instances

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

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 Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats: * projects/{project}/locations/-/clusters/- * projects/{project}/locations/{region}/clusters/-
↳ 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 Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats:

• projects/{project}/locations/-/clusters/-
• projects/{project}/locations/{region}/clusters/-

Returns
Type	Description
string

setParent

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

• projects/{project}/locations/-/clusters/-
• projects/{project}/locations/{region}/clusters/-

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 Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats: projects/{project}/locations/-/clusters/- projects/{project}/locations/{region}/clusters/- Please see Google\Cloud\AlloyDb\V1\AlloyDBAdminClient::clusterName() for help formatting this field.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\ListInstancesRequest