Reference documentation and code samples for the Google Cloud Memorystore for Memcached V1 API class Google::Cloud::Memcache::V1::ListInstancesRequest.
(::String) — List filter. For example, exclude all Memcached instances with name as
my-instance by specifying "name != my-instance".
#filter=
deffilter=(value)->::String
Parameter
value (::String) — List filter. For example, exclude all Memcached instances with name as
my-instance by specifying "name != my-instance".
Returns
(::String) — List filter. For example, exclude all Memcached instances with name as
my-instance by specifying "name != my-instance".
#order_by
deforder_by()->::String
Returns
(::String) — Sort results. Supported values are "name", "name desc" or "" (unsorted).
#order_by=
deforder_by=(value)->::String
Parameter
value (::String) — Sort results. Supported values are "name", "name desc" or "" (unsorted).
Returns
(::String) — Sort results. Supported values are "name", "name desc" or "" (unsorted).
#page_size
defpage_size()->::Integer
Returns
(::Integer) — 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 instances left to be queried.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — 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 instances left to be queried.
Returns
(::Integer) — 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 instances left to be queried.
#page_token
defpage_token()->::String
Returns
(::String) — The next_page_token value returned from a previous List request, if any.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — The next_page_token value returned from a previous List request, if any.
Returns
(::String) — The next_page_token value returned from a previous List request, if any.
#parent
defparent()->::String
Returns
(::String) — Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
where location_id refers to a GCP region
#parent=
defparent=(value)->::String
Parameter
value (::String) — Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
where location_id refers to a GCP region
Returns
(::String) — Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
where location_id refers to a GCP region
[[["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-08-28 UTC."],[],[],null,["# Google Cloud Memorystore for Memcached V1 API - Class Google::Cloud::Memcache::V1::ListInstancesRequest (v2.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.0 (latest)](/ruby/docs/reference/google-cloud-memcache-v1/latest/Google-Cloud-Memcache-V1-ListInstancesRequest)\n- [2.0.1](/ruby/docs/reference/google-cloud-memcache-v1/2.0.1/Google-Cloud-Memcache-V1-ListInstancesRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-memcache-v1/1.2.0/Google-Cloud-Memcache-V1-ListInstancesRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-memcache-v1/1.1.0/Google-Cloud-Memcache-V1-ListInstancesRequest)\n- [1.0.2](/ruby/docs/reference/google-cloud-memcache-v1/1.0.2/Google-Cloud-Memcache-V1-ListInstancesRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-memcache-v1/0.9.0/Google-Cloud-Memcache-V1-ListInstancesRequest)\n- [0.8.2](/ruby/docs/reference/google-cloud-memcache-v1/0.8.2/Google-Cloud-Memcache-V1-ListInstancesRequest)\n- [0.7.0](/ruby/docs/reference/google-cloud-memcache-v1/0.7.0/Google-Cloud-Memcache-V1-ListInstancesRequest)\n- [0.6.1](/ruby/docs/reference/google-cloud-memcache-v1/0.6.1/Google-Cloud-Memcache-V1-ListInstancesRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-memcache-v1/0.5.0/Google-Cloud-Memcache-V1-ListInstancesRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-memcache-v1/0.4.0/Google-Cloud-Memcache-V1-ListInstancesRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-memcache-v1/0.3.0/Google-Cloud-Memcache-V1-ListInstancesRequest)\n- [0.2.5](/ruby/docs/reference/google-cloud-memcache-v1/0.2.5/Google-Cloud-Memcache-V1-ListInstancesRequest) \nReference documentation and code samples for the Google Cloud Memorystore for Memcached V1 API class Google::Cloud::Memcache::V1::ListInstancesRequest.\n\nRequest for [ListInstances](/ruby/docs/reference/google-cloud-memcache-v1/latest/Google-Cloud-Memcache-V1-CloudMemcache-Client#Google__Cloud__Memcache__V1__CloudMemcache__Client_list_instances_instance_ \"Google::Cloud::Memcache::V1::CloudMemcache::Client#list_instances (method)\"). \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- List filter. For example, exclude all Memcached instances with name as my-instance by specifying `\"name != my-instance\"`.\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- List filter. For example, exclude all Memcached instances with name as my-instance by specifying `\"name != my-instance\"`. \n**Returns**\n\n- (::String) --- List filter. For example, exclude all Memcached instances with name as my-instance by specifying `\"name != my-instance\"`.\n\n### #order_by\n\n def order_by() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).\n\n### #order_by=\n\n def order_by=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted). \n**Returns**\n\n- (::String) --- Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The maximum number of items to return.\n\n If not specified, a default value of 1000 will be used by the service.\n Regardless of the `page_size` value, the response may include a partial\n list and a caller should only rely on response's\n [`next_page_token`](/ruby/docs/reference/google-cloud-memcache-v1/latest/Google-Cloud-Memcache-V1-ListInstancesResponse#Google__Cloud__Memcache__V1__ListInstancesResponse_next_page_token_instance_ \"Google::Cloud::Memcache::V1::ListInstancesResponse#next_page_token (method)\")\n to determine if there are more instances left to be queried.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The maximum number of items to return.\n\n\n If not specified, a default value of 1000 will be used by the service.\n Regardless of the `page_size` value, the response may include a partial\n list and a caller should only rely on response's\n [`next_page_token`](/ruby/docs/reference/google-cloud-memcache-v1/latest/Google-Cloud-Memcache-V1-ListInstancesResponse#Google__Cloud__Memcache__V1__ListInstancesResponse_next_page_token_instance_ \"Google::Cloud::Memcache::V1::ListInstancesResponse#next_page_token (method)\")\nto determine if there are more instances left to be queried. \n**Returns**\n\n- (::Integer) --- The maximum number of items to return.\n\n If not specified, a default value of 1000 will be used by the service.\n Regardless of the `page_size` value, the response may include a partial\n list and a caller should only rely on response's\n [`next_page_token`](/ruby/docs/reference/google-cloud-memcache-v1/latest/Google-Cloud-Memcache-V1-ListInstancesResponse#Google__Cloud__Memcache__V1__ListInstancesResponse_next_page_token_instance_ \"Google::Cloud::Memcache::V1::ListInstancesResponse#next_page_token (method)\")\n to determine if there are more instances left to be queried.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The `next_page_token` value returned from a previous List request, if any.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The `next_page_token` value returned from a previous List request, if any. \n**Returns**\n\n- (::String) --- The `next_page_token` value returned from a previous List request, if any.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region \n**Returns**\n\n- (::String) --- Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region"]]
