Reference documentation and code samples for the Google Cloud Redis Cluster V1 Client class ListClustersRequest.
Request for ListClusters.
Generated from protobuf message google.cloud.redis.cluster.v1.ListClustersRequest
Namespace
Google \ Cloud \ Redis \ Cluster \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.
↳ page_size
int
The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more clusters left to be queried.
↳ page_token
string
The next_page_token value returned from a previous ListClusters request, if any.
getParent
Required. The resource name of the cluster location using the form:
projects/{project_id}/locations/{location_id}
where location_id refers to a GCP region.
Returns
Type
Description
string
setParent
Required. The resource name of the cluster location using the form:
projects/{project_id}/locations/{location_id}
where location_id refers to a GCP region.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
The maximum number of items to return.
If not specified, a default value of 1000 will be used by the service.
Regardless of the page_size value, the response may include a partial list
and a caller should only rely on response's
next_page_token
to determine if there are more clusters left to be queried.
Returns
Type
Description
int
setPageSize
The maximum number of items to return.
If not specified, a default value of 1000 will be used by the service.
Regardless of the page_size value, the response may include a partial list
and a caller should only rely on response's
next_page_token
to determine if there are more clusters left to be queried.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
The next_page_token value returned from a previous
ListClusters request, if any.
Returns
Type
Description
string
setPageToken
The next_page_token value returned from a previous
ListClusters request, if any.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The resource name of the cluster location using the form:
projects/{project_id}/locations/{location_id}
where location_id refers to a GCP region. Please see
CloudRedisClusterClient::locationName() 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 Redis Cluster V1 Client - Class ListClustersRequest (0.5.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.5.1 (latest)](/php/docs/reference/cloud-redis-cluster/latest/V1.ListClustersRequest)\n- [0.5.0](/php/docs/reference/cloud-redis-cluster/0.5.0/V1.ListClustersRequest)\n- [0.4.1](/php/docs/reference/cloud-redis-cluster/0.4.1/V1.ListClustersRequest)\n- [0.3.2](/php/docs/reference/cloud-redis-cluster/0.3.2/V1.ListClustersRequest)\n- [0.2.5](/php/docs/reference/cloud-redis-cluster/0.2.5/V1.ListClustersRequest)\n- [0.1.0](/php/docs/reference/cloud-redis-cluster/0.1.0/V1.ListClustersRequest) \nReference documentation and code samples for the Google Cloud Redis Cluster V1 Client class ListClustersRequest.\n\nRequest for ListClusters.\n\nGenerated from protobuf message `google.cloud.redis.cluster.v1.ListClustersRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Redis \\\\ Cluster \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The resource name of the cluster location using the form:\n`projects/{project_id}/locations/{location_id}`\nwhere `location_id` refers to a GCP region.\n\n### setParent\n\nRequired. The resource name of the cluster location using the form:\n`projects/{project_id}/locations/{location_id}`\nwhere `location_id` refers to a GCP region.\n\n### getPageSize\n\nThe maximum number of items to return.\n\nIf not specified, a default value of 1000 will be used by the service.\nRegardless of the page_size value, the response may include a partial list\nand a caller should only rely on response's\n[`next_page_token`](/php/docs/reference/cloud-redis-cluster/latest/V1.ListClustersResponse#_Google_Cloud_Redis_Cluster_V1_ListClustersResponse__getNextPageToken__)\nto determine if there are more clusters left to be queried.\n\n### setPageSize\n\nThe maximum number of items to return.\n\nIf not specified, a default value of 1000 will be used by the service.\nRegardless of the page_size value, the response may include a partial list\nand a caller should only rely on response's\n[`next_page_token`](/php/docs/reference/cloud-redis-cluster/latest/V1.ListClustersResponse#_Google_Cloud_Redis_Cluster_V1_ListClustersResponse__getNextPageToken__)\nto determine if there are more clusters left to be queried.\n\n### getPageToken\n\nThe `next_page_token` value returned from a previous\nListClusters request, if any.\n\n### setPageToken\n\nThe `next_page_token` value returned from a previous\nListClusters request, if any.\n\n### static::build"]]
