Generated from protobuf messagegoogle.cloud.memcache.v1.ListInstancesRequest
Namespace
Google \ Cloud \ Memcache \ 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 thepage_sizevalue, 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 previous List request, if any.
↳ filter
string
List filter. For example, exclude all Memcached instances with name as my-instance by specifying"name != my-instance".
↳ order_by
string
Sort results. Supported values are "name", "name desc" or "" (unsorted).
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 thepage_sizevalue, 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 thepage_sizevalue, 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 previous List request, if any.
Returns
Type
Description
string
setPageToken
Thenext_page_tokenvalue returned from a previous List request, if any.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
List filter. For example, exclude all Memcached instances with name as
my-instance by specifying"name != my-instance".
Returns
Type
Description
string
setFilter
List filter. For example, exclude all Memcached instances with name as
my-instance by specifying"name != my-instance".
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
Sort results. Supported values are "name", "name desc" or "" (unsorted).
Returns
Type
Description
string
setOrderBy
Sort results. Supported values are "name", "name desc" or "" (unsorted).
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 seeCloudMemcacheClient::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,["# Memorystore for Memcached V1 Client - Class ListInstancesRequest (2.0.4)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.4 (latest)](/php/docs/reference/cloud-memcache/latest/V1.ListInstancesRequest)\n- [2.0.3](/php/docs/reference/cloud-memcache/2.0.3/V1.ListInstancesRequest)\n- [1.3.5](/php/docs/reference/cloud-memcache/1.3.5/V1.ListInstancesRequest)\n- [1.2.2](/php/docs/reference/cloud-memcache/1.2.2/V1.ListInstancesRequest)\n- [1.1.1](/php/docs/reference/cloud-memcache/1.1.1/V1.ListInstancesRequest)\n- [1.0.5](/php/docs/reference/cloud-memcache/1.0.5/V1.ListInstancesRequest) \nReference documentation and code samples for the Memorystore for Memcached V1 Client class ListInstancesRequest.\n\nRequest for [ListInstances](/php/docs/reference/cloud-memcache/latest/V1.Client.CloudMemcacheClient#_Google_Cloud_Memcache_V1_Client_CloudMemcacheClient__listInstances__).\n\nGenerated from protobuf message `google.cloud.memcache.v1.ListInstancesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Memcache \\\\ 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\nlist and a caller should only rely on response's\n[`next_page_token`](/php/docs/reference/cloud-memcache/latest/V1.ListInstancesResponse#_Google_Cloud_Memcache_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\nlist and a caller should only rely on response's\n[`next_page_token`](/php/docs/reference/cloud-memcache/latest/V1.ListInstancesResponse#_Google_Cloud_Memcache_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 List request, if any.\n\n### setPageToken\n\nThe `next_page_token` value returned from a previous List request, if any.\n\n### getFilter\n\nList filter. For example, exclude all Memcached instances with name as\nmy-instance by specifying `\"name != my-instance\"`.\n\n### setFilter\n\nList filter. For example, exclude all Memcached instances with name as\nmy-instance by specifying `\"name != my-instance\"`.\n\n### getOrderBy\n\nSort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).\n\n### setOrderBy\n\nSort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).\n\n### static::build"]]
