Class: Google::Cloud::Redis::V1beta1::ListInstancesResponse

Inherits:

Object

Object
Google::Cloud::Redis::V1beta1::ListInstancesResponse

show all

Defined in:: lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb

Overview

Response for ListInstances.

Instance Attribute Summary collapse

#instances ⇒ Array<Google::Cloud::Redis::V1beta1::Instance>
A list of Redis instances in the project in the specified location, or across all locations.
#next_page_token ⇒ String
Token to retrieve the next page of results, or empty if there are no more results in the list.

Instance Attribute Details

#instances ⇒ `Array<Google::Cloud::Redis::V1beta1::Instance>`

Returns A list of Redis instances in the project in the specified location, or across all locations.

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 dummy 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".

Returns:

(Array<Google::Cloud::Redis::V1beta1::Instance>) —
A list of Redis instances in the project in the specified location, or across all locations.

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 dummy 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".

181	# File 'lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb', line 181 class ListInstancesResponse; end

#next_page_token ⇒ `String`

Returns Token to retrieve the next page of results, or empty if there are no more results in the list.