Generated from protobuf messagegoogle.cloud.redis.v1.ListInstancesRequest
Namespace
Google \ Cloud \ Redis \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the instance location using the form:projects/{project_id}/locations/{location_id}wherelocation_idrefers 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'snext_page_tokento determine if there are more instances left to be queried.
↳ page_token
string
Thenext_page_tokenvalue returned from a previousListInstancesrequest, if any.
getParent
Required. The resource name of the instance location using the form:projects/{project_id}/locations/{location_id}wherelocation_idrefers to a GCP region.
Returns
Type
Description
string
setParent
Required. The resource name of the instance location using the form:projects/{project_id}/locations/{location_id}wherelocation_idrefers 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'snext_page_tokento determine if there are more instances 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'snext_page_tokento determine if there are more instances left to be queried.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Thenext_page_tokenvalue returned from a previousListInstancesrequest, if
any.
Returns
Type
Description
string
setPageToken
Thenext_page_tokenvalue returned from a previousListInstancesrequest, if
any.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The resource name of the instance location using the form:projects/{project_id}/locations/{location_id}wherelocation_idrefers to a GCP region. Please seeCloudRedisClient::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-09 UTC."],[],[],null,["# Google Cloud Redis V1 Client - Class ListInstancesRequest (2.1.6)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.6 (latest)](/php/docs/reference/cloud-redis/latest/V1.ListInstancesRequest)\n- [2.1.5](/php/docs/reference/cloud-redis/2.1.5/V1.ListInstancesRequest)\n- [2.0.0](/php/docs/reference/cloud-redis/2.0.0/V1.ListInstancesRequest)\n- [1.9.5](/php/docs/reference/cloud-redis/1.9.5/V1.ListInstancesRequest)\n- [1.8.4](/php/docs/reference/cloud-redis/1.8.4/V1.ListInstancesRequest)\n- [1.7.0](/php/docs/reference/cloud-redis/1.7.0/V1.ListInstancesRequest)\n- [1.6.12](/php/docs/reference/cloud-redis/1.6.12/V1.ListInstancesRequest) \nReference documentation and code samples for the Google Cloud Redis V1 Client class ListInstancesRequest.\n\nRequest for [ListInstances](/php/docs/reference/cloud-redis/latest/V1.Client.CloudRedisClient#_Google_Cloud_Redis_V1_Client_CloudRedisClient__listInstances__).\n\nGenerated from protobuf message `google.cloud.redis.v1.ListInstancesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Redis \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The resource name of the instance 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 instance 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/latest/V1.ListInstancesResponse#_Google_Cloud_Redis_V1_ListInstancesResponse__getNextPageToken__)\nto determine if there are more instances 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/latest/V1.ListInstancesResponse#_Google_Cloud_Redis_V1_ListInstancesResponse__getNextPageToken__)\nto determine if there are more instances left to be queried.\n\n### getPageToken\n\nThe `next_page_token` value returned from a previous\n[ListInstances](/php/docs/reference/cloud-redis/latest/V1.Client.CloudRedisClient#_Google_Cloud_Redis_V1_Client_CloudRedisClient__listInstances__) request, if\nany.\n\n### setPageToken\n\nThe `next_page_token` value returned from a previous\n[ListInstances](/php/docs/reference/cloud-redis/latest/V1.Client.CloudRedisClient#_Google_Cloud_Redis_V1_Client_CloudRedisClient__listInstances__) request, if\nany.\n\n### static::build"]]
