com.google.cloud.redis.v1

Interface ListInstancesResponseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListInstancesResponse, ListInstancesResponse.Builder

public interface ListInstancesResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Instance	getInstances(int index) A list of Redis instances in the project in the specified location, or across all locations.
int	getInstancesCount() A list of Redis instances in the project in the specified location, or across all locations.
List<Instance>	getInstancesList() A list of Redis instances in the project in the specified location, or across all locations.
InstanceOrBuilder	getInstancesOrBuilder(int index) A list of Redis instances in the project in the specified location, or across all locations.
List<? extends InstanceOrBuilder>	getInstancesOrBuilderList() A list of Redis instances in the project in the specified location, or across all locations.
String	getNextPageToken() Token to retrieve the next page of results, or empty if there are no more results in the list.
com.google.protobuf.ByteString	getNextPageTokenBytes() Token to retrieve the next page of results, or empty if there are no more results in the list.
String	getUnreachable(int index) Locations that could not be reached.
com.google.protobuf.ByteString	getUnreachableBytes(int index) Locations that could not be reached.
int	getUnreachableCount() Locations that could not be reached.
List<String>	getUnreachableList() Locations that could not be reached.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getInstancesList

List<Instance> getInstancesList()

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

repeated .google.cloud.redis.v1.Instance instances = 1;

getInstances

Instance getInstances(int index)

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

repeated .google.cloud.redis.v1.Instance instances = 1;

getInstancesCount

int getInstancesCount()

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

repeated .google.cloud.redis.v1.Instance instances = 1;

getInstancesOrBuilderList

List<? extends InstanceOrBuilder> getInstancesOrBuilderList()

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

repeated .google.cloud.redis.v1.Instance instances = 1;

getInstancesOrBuilder

InstanceOrBuilder getInstancesOrBuilder(int index)

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

repeated .google.cloud.redis.v1.Instance instances = 1;

getNextPageToken

String getNextPageToken()

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

string next_page_token = 2;

Returns:

The nextPageToken.

getNextPageTokenBytes

com.google.protobuf.ByteString getNextPageTokenBytes()

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

string next_page_token = 2;

Returns:

The bytes for nextPageToken.

getUnreachableList

List<String> getUnreachableList()

 Locations that could not be reached.
 

repeated string unreachable = 3;

Returns:

A list containing the unreachable.

getUnreachableCount

int getUnreachableCount()

 Locations that could not be reached.
 

repeated string unreachable = 3;

Returns:

The count of unreachable.

getUnreachable

String getUnreachable(int index)

 Locations that could not be reached.
 

repeated string unreachable = 3;

Parameters:

index - The index of the element to return.

Returns:

The unreachable at the given index.

getUnreachableBytes

com.google.protobuf.ByteString getUnreachableBytes(int index)

 Locations that could not be reached.
 

repeated string unreachable = 3;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the unreachable at the given index.