Reference documentation and code samples for the Google Cloud Memorystore for Redis V1beta1 API class Google::Cloud::Redis::V1beta1::ListInstancesResponse.
If the location_id in the parent field of the request is "-", all regions
available to the project are queried, and the results aggregated.
If in such an aggregated query a location is unavailable, a placeholder
Redis entry is included in the response with the name field set to a
value of the form
projects/{project_id}/locations/{location_id}/instances/- and the
status field set to ERROR and status_message field set to "location not
available for ListInstances".
If the location_id in the parent field of the request is "-", all regions
available to the project are queried, and the results aggregated.
If in such an aggregated query a location is unavailable, a placeholder
Redis entry is included in the response with the name field set to a
value of the form
projects/{project_id}/locations/{location_id}/instances/- and the
status field set to ERROR and status_message field set to "location not
available for ListInstances".
If the location_id in the parent field of the request is "-", all regions
available to the project are queried, and the results aggregated.
If in such an aggregated query a location is unavailable, a placeholder
Redis entry is included in the response with the name field set to a
value of the form
projects/{project_id}/locations/{location_id}/instances/- and the
status field set to ERROR and status_message field set to "location not
available for ListInstances".
#next_page_token
defnext_page_token()->::String
Returns
(::String) — Token to retrieve the next page of results, or empty if there are no more
results in the list.
#next_page_token=
defnext_page_token=(value)->::String
Parameter
value (::String) — Token to retrieve the next page of results, or empty if there are no more
results in the list.
Returns
(::String) — Token to retrieve the next page of results, or empty if there are no more
results in the list.
#unreachable
defunreachable()->::Array<::String>
Returns
(::Array<::String>) — Locations that could not be reached.
#unreachable=
defunreachable=(value)->::Array<::String>
Parameter
value (::Array<::String>) — Locations that could not be reached.
Returns
(::Array<::String>) — Locations that could not be reached.
[[["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 Memorystore for Redis V1beta1 API - Class Google::Cloud::Redis::V1beta1::ListInstancesResponse (v0.17.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.17.0 (latest)](/ruby/docs/reference/google-cloud-redis-v1beta1/latest/Google-Cloud-Redis-V1beta1-ListInstancesResponse)\n- [0.16.1](/ruby/docs/reference/google-cloud-redis-v1beta1/0.16.1/Google-Cloud-Redis-V1beta1-ListInstancesResponse)\n- [0.15.0](/ruby/docs/reference/google-cloud-redis-v1beta1/0.15.0/Google-Cloud-Redis-V1beta1-ListInstancesResponse)\n- [0.14.0](/ruby/docs/reference/google-cloud-redis-v1beta1/0.14.0/Google-Cloud-Redis-V1beta1-ListInstancesResponse)\n- [0.13.2](/ruby/docs/reference/google-cloud-redis-v1beta1/0.13.2/Google-Cloud-Redis-V1beta1-ListInstancesResponse)\n- [0.12.2](/ruby/docs/reference/google-cloud-redis-v1beta1/0.12.2/Google-Cloud-Redis-V1beta1-ListInstancesResponse)\n- [0.11.0](/ruby/docs/reference/google-cloud-redis-v1beta1/0.11.0/Google-Cloud-Redis-V1beta1-ListInstancesResponse)\n- [0.10.1](/ruby/docs/reference/google-cloud-redis-v1beta1/0.10.1/Google-Cloud-Redis-V1beta1-ListInstancesResponse)\n- [0.9.0](/ruby/docs/reference/google-cloud-redis-v1beta1/0.9.0/Google-Cloud-Redis-V1beta1-ListInstancesResponse)\n- [0.8.0](/ruby/docs/reference/google-cloud-redis-v1beta1/0.8.0/Google-Cloud-Redis-V1beta1-ListInstancesResponse)\n- [0.7.0](/ruby/docs/reference/google-cloud-redis-v1beta1/0.7.0/Google-Cloud-Redis-V1beta1-ListInstancesResponse)\n- [0.6.0](/ruby/docs/reference/google-cloud-redis-v1beta1/0.6.0/Google-Cloud-Redis-V1beta1-ListInstancesResponse)\n- [0.5.1](/ruby/docs/reference/google-cloud-redis-v1beta1/0.5.1/Google-Cloud-Redis-V1beta1-ListInstancesResponse) \nReference documentation and code samples for the Google Cloud Memorystore for Redis V1beta1 API class Google::Cloud::Redis::V1beta1::ListInstancesResponse.\n\nResponse for [ListInstances](/ruby/docs/reference/google-cloud-redis-v1beta1/latest/Google-Cloud-Redis-V1beta1-CloudRedis-Client#Google__Cloud__Redis__V1beta1__CloudRedis__Client_list_instances_instance_ \"Google::Cloud::Redis::V1beta1::CloudRedis::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### #instances\n\n def instances() -\u003e ::Array\u003c::Google::Cloud::Redis::V1beta1::Instance\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Redis::V1beta1::Instance](./Google-Cloud-Redis-V1beta1-Instance)\\\u003e) --- A list of Redis instances in the project in the specified location, or across all locations.\n\n\n If the `location_id` in the parent field of the request is \"-\", all regions\n available to the project are queried, and the results aggregated.\n If in such an aggregated query a location is unavailable, a placeholder\n Redis entry is included in the response with the `name` field set to a\n value of the form\n `projects/{project_id}/locations/{location_id}/instances/`- and the\n `status` field set to ERROR and `status_message` field set to \"location not\n available for ListInstances\".\n\n### #instances=\n\n def instances=(value) -\u003e ::Array\u003c::Google::Cloud::Redis::V1beta1::Instance\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::Redis::V1beta1::Instance](./Google-Cloud-Redis-V1beta1-Instance)\\\u003e) --- A list of Redis instances in the project in the specified location, or across all locations.\n\n\n If the `location_id` in the parent field of the request is \"-\", all regions\n available to the project are queried, and the results aggregated.\n If in such an aggregated query a location is unavailable, a placeholder\n Redis entry is included in the response with the `name` field set to a\n value of the form\n `projects/{project_id}/locations/{location_id}/instances/`- and the\n `status` field set to ERROR and `status_message` field set to \"location not\navailable for ListInstances\". \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Redis::V1beta1::Instance](./Google-Cloud-Redis-V1beta1-Instance)\\\u003e) --- A list of Redis instances in the project in the specified location, or across all locations.\n\n\n If the `location_id` in the parent field of the request is \"-\", all regions\n available to the project are queried, and the results aggregated.\n If in such an aggregated query a location is unavailable, a placeholder\n Redis entry is included in the response with the `name` field set to a\n value of the form\n `projects/{project_id}/locations/{location_id}/instances/`- and the\n `status` field set to ERROR and `status_message` field set to \"location not\n available for ListInstances\".\n\n### #next_page_token\n\n def next_page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Token to retrieve the next page of results, or empty if there are no more results in the list.\n\n### #next_page_token=\n\n def next_page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Token to retrieve the next page of results, or empty if there are no more results in the list. \n**Returns**\n\n- (::String) --- Token to retrieve the next page of results, or empty if there are no more results in the list.\n\n### #unreachable\n\n def unreachable() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Locations that could not be reached.\n\n### #unreachable=\n\n def unreachable=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- Locations that could not be reached. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Locations that could not be reached."]]
