Class: Google::Cloud::Redis::V1::ListInstancesResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/redis/v1/cloud_redis.rb

Overview

Response for ListInstances.

Instance Attribute Summary collapse

Instance Attribute Details

#instances ⇒ ::Array<::Google::Cloud::Redis::V1::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 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".

Returns:

  • (::Array<::Google::Cloud::Redis::V1::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 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".



544
545
546
547
 
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 544

class ListInstancesResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.

Returns:

  • (::String) —

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



544
545
546
547
 
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 544

class ListInstancesResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#unreachable ⇒ ::Array<::String>

Returns Locations that could not be reached.

Returns:

  • (::Array<::String>) —

    Locations that could not be reached.



544
545
546
547
 
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 544

class ListInstancesResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end