Google Cloud Memorystore for Redis V1 API - Class Google::Cloud::Redis::Cluster::V1::ListClustersResponse (v0.2.2)

Reference documentation and code samples for the Google Cloud Memorystore for Redis V1 API class Google::Cloud::Redis::Cluster::V1::ListClustersResponse.

Response for [ListClusters][CloudRedis.ListClusters].

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#clusters

def clusters() -> ::Array<::Google::Cloud::Redis::Cluster::V1::Cluster>
Returns
  • (::Array<::Google::Cloud::Redis::Cluster::V1::Cluster>) — A list of Redis clusters 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 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}/clusters/- and the status field set to ERROR and status_message field set to "location not available for ListClusters".

#clusters=

def clusters=(value) -> ::Array<::Google::Cloud::Redis::Cluster::V1::Cluster>
Parameter
  • value (::Array<::Google::Cloud::Redis::Cluster::V1::Cluster>) — A list of Redis clusters 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 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}/clusters/- and the status field set to ERROR and status_message field set to "location not available for ListClusters".

Returns
  • (::Array<::Google::Cloud::Redis::Cluster::V1::Cluster>) — A list of Redis clusters 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 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}/clusters/- and the status field set to ERROR and status_message field set to "location not available for ListClusters".

#next_page_token

def next_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=

def next_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

def unreachable() -> ::Array<::String>
Returns
  • (::Array<::String>) — Locations that could not be reached.

#unreachable=

def unreachable=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Locations that could not be reached.
Returns
  • (::Array<::String>) — Locations that could not be reached.