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 messagegoogle.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 seeAlloyDBAdminClient::clusterName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud AlloyDB for PostgreSQL V1 Client - Class ListInstancesRequest (1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/php/docs/reference/cloud-alloydb/latest/V1.ListInstancesRequest)\n- [1.4.0](/php/docs/reference/cloud-alloydb/1.4.0/V1.ListInstancesRequest)\n- [1.3.0](/php/docs/reference/cloud-alloydb/1.3.0/V1.ListInstancesRequest)\n- [1.2.0](/php/docs/reference/cloud-alloydb/1.2.0/V1.ListInstancesRequest)\n- [1.1.3](/php/docs/reference/cloud-alloydb/1.1.3/V1.ListInstancesRequest)\n- [1.0.0](/php/docs/reference/cloud-alloydb/1.0.0/V1.ListInstancesRequest)\n- [0.10.3](/php/docs/reference/cloud-alloydb/0.10.3/V1.ListInstancesRequest)\n- [0.9.0](/php/docs/reference/cloud-alloydb/0.9.0/V1.ListInstancesRequest)\n- [0.8.0](/php/docs/reference/cloud-alloydb/0.8.0/V1.ListInstancesRequest)\n- [0.7.1](/php/docs/reference/cloud-alloydb/0.7.1/V1.ListInstancesRequest)\n- [0.6.0](/php/docs/reference/cloud-alloydb/0.6.0/V1.ListInstancesRequest)\n- [0.5.0](/php/docs/reference/cloud-alloydb/0.5.0/V1.ListInstancesRequest)\n- [0.4.0](/php/docs/reference/cloud-alloydb/0.4.0/V1.ListInstancesRequest)\n- [0.3.0](/php/docs/reference/cloud-alloydb/0.3.0/V1.ListInstancesRequest)\n- [0.2.1](/php/docs/reference/cloud-alloydb/0.2.1/V1.ListInstancesRequest)\n- [0.1.3](/php/docs/reference/cloud-alloydb/0.1.3/V1.ListInstancesRequest) \nReference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class ListInstancesRequest.\n\nMessage for requesting list of Instances\n\nGenerated from protobuf message `google.cloud.alloydb.v1.ListInstancesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AlloyDb \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The name of the parent resource. For the required format, see the\ncomment on the Instance.name field. Additionally, you can perform an\naggregated list operation by specifying a value with one of the following\nformats:\n\n- projects/{project}/locations/-/clusters/-\n- projects/{project}/locations/{region}/clusters/-\n\n### setParent\n\nRequired. The name of the parent resource. For the required format, see the\ncomment on the Instance.name field. Additionally, you can perform an\naggregated list operation by specifying a value with one of the following\nformats:\n\n- projects/{project}/locations/-/clusters/-\n- projects/{project}/locations/{region}/clusters/-\n\n### getPageSize\n\nOptional. Requested page size. Server may return fewer items than\nrequested. If unspecified, server will pick an appropriate default.\n\n### setPageSize\n\nOptional. Requested page size. Server may return fewer items than\nrequested. If unspecified, server will pick an appropriate default.\n\n### getPageToken\n\nA token identifying a page of results the server should return.\n\n### setPageToken\n\nA token identifying a page of results the server should return.\n\n### getFilter\n\nOptional. Filtering results\n\n### setFilter\n\nOptional. Filtering results\n\n### getOrderBy\n\nOptional. Hint for how to order the results\n\n### setOrderBy\n\nOptional. Hint for how to order the results\n\n### static::build"]]
