Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class ListDatabasesRequest.
Message for requesting list of Databases.
Generated from protobuf messagegoogle.cloud.alloydb.v1.ListDatabasesRequest
Namespace
Google \ Cloud \ AlloyDb \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. Parent value for ListDatabasesRequest.
↳ page_size
int
Optional. The maximum number of databases to return. The service may return fewer than this value. If unspecified, 2000 is the default page_size. The max value of page_size will be 4000, values above max will be coerced to max.
↳ page_token
string
Optional. A page token, received from a previousListDatabasescall. This should be provided to retrieve the subsequent page. This field is currently not supported, its value will be ignored if passed.
↳ filter
string
Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
getParent
Required. Parent value for ListDatabasesRequest.
Returns
Type
Description
string
setParent
Required. Parent value for ListDatabasesRequest.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of databases to return. The service may return
fewer than this value. If unspecified, 2000 is the default page_size. The
max value of page_size will be 4000, values above max will be coerced to
max.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of databases to return. The service may return
fewer than this value. If unspecified, 2000 is the default page_size. The
max value of page_size will be 4000, values above max will be coerced to
max.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. A page token, received from a previousListDatabasescall.
This should be provided to retrieve the subsequent page.
This field is currently not supported, its value will be ignored if passed.
Returns
Type
Description
string
setPageToken
Optional. A page token, received from a previousListDatabasescall.
This should be provided to retrieve the subsequent page.
This field is currently not supported, its value will be ignored if passed.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. Filtering results.
This field is currently not supported, its value will be ignored if passed.
Returns
Type
Description
string
setFilter
Optional. Filtering results.
This field is currently not supported, its value will be ignored if passed.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. Parent value for ListDatabasesRequest. 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 ListDatabasesRequest (1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/php/docs/reference/cloud-alloydb/latest/V1.ListDatabasesRequest)\n- [1.4.0](/php/docs/reference/cloud-alloydb/1.4.0/V1.ListDatabasesRequest)\n- [1.3.0](/php/docs/reference/cloud-alloydb/1.3.0/V1.ListDatabasesRequest)\n- [1.2.0](/php/docs/reference/cloud-alloydb/1.2.0/V1.ListDatabasesRequest)\n- [1.1.3](/php/docs/reference/cloud-alloydb/1.1.3/V1.ListDatabasesRequest)\n- [1.0.0](/php/docs/reference/cloud-alloydb/1.0.0/V1.ListDatabasesRequest)\n- [0.10.3](/php/docs/reference/cloud-alloydb/0.10.3/V1.ListDatabasesRequest)\n- [0.9.0](/php/docs/reference/cloud-alloydb/0.9.0/V1.ListDatabasesRequest)\n- [0.8.0](/php/docs/reference/cloud-alloydb/0.8.0/V1.ListDatabasesRequest)\n- [0.7.1](/php/docs/reference/cloud-alloydb/0.7.1/V1.ListDatabasesRequest)\n- [0.6.0](/php/docs/reference/cloud-alloydb/0.6.0/V1.ListDatabasesRequest)\n- [0.5.0](/php/docs/reference/cloud-alloydb/0.5.0/V1.ListDatabasesRequest)\n- [0.4.0](/php/docs/reference/cloud-alloydb/0.4.0/V1.ListDatabasesRequest)\n- [0.3.0](/php/docs/reference/cloud-alloydb/0.3.0/V1.ListDatabasesRequest)\n- [0.2.1](/php/docs/reference/cloud-alloydb/0.2.1/V1.ListDatabasesRequest)\n- [0.1.3](/php/docs/reference/cloud-alloydb/0.1.3/V1.ListDatabasesRequest) \nReference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class ListDatabasesRequest.\n\nMessage for requesting list of Databases.\n\nGenerated from protobuf message `google.cloud.alloydb.v1.ListDatabasesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AlloyDb \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Parent value for ListDatabasesRequest.\n\n### setParent\n\nRequired. Parent value for ListDatabasesRequest.\n\n### getPageSize\n\nOptional. The maximum number of databases to return. The service may return\nfewer than this value. If unspecified, 2000 is the default page_size. The\nmax value of page_size will be 4000, values above max will be coerced to\nmax.\n\n### setPageSize\n\nOptional. The maximum number of databases to return. The service may return\nfewer than this value. If unspecified, 2000 is the default page_size. The\nmax value of page_size will be 4000, values above max will be coerced to\nmax.\n\n### getPageToken\n\nOptional. A page token, received from a previous `ListDatabases` call.\n\nThis should be provided to retrieve the subsequent page.\nThis field is currently not supported, its value will be ignored if passed.\n\n### setPageToken\n\nOptional. A page token, received from a previous `ListDatabases` call.\n\nThis should be provided to retrieve the subsequent page.\nThis field is currently not supported, its value will be ignored if passed.\n\n### getFilter\n\nOptional. Filtering results.\n\nThis field is currently not supported, its value will be ignored if passed.\n\n### setFilter\n\nOptional. Filtering results.\n\nThis field is currently not supported, its value will be ignored if passed.\n\n### static::build"]]
