Interface ListInstancesResponseOrBuilder (2.25.0) 

public interface ListInstancesResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getInstances(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
Instance

getInstancesCount()

public abstract 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;

Returns
Type Description
int

getInstancesList()

public abstract 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;

Returns
Type Description
List<Instance>

getInstancesOrBuilder(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
InstanceOrBuilder

getInstancesOrBuilderList()

public abstract 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;

Returns
Type Description
List<? extends com.google.cloud.redis.v1.InstanceOrBuilder>

getNextPageToken()

public abstract 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
Type Description
String

The nextPageToken.

getNextPageTokenBytes()

public abstract 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
Type Description
ByteString

The bytes for nextPageToken.

getUnreachable(int index)

public abstract String getUnreachable(int index)

Locations that could not be reached.

repeated string unreachable = 3;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The unreachable at the given index.

getUnreachableBytes(int index)

public abstract ByteString getUnreachableBytes(int index)

Locations that could not be reached.

repeated string unreachable = 3;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the unreachable at the given index.

getUnreachableCount()

public abstract int getUnreachableCount()

Locations that could not be reached.

repeated string unreachable = 3;

Returns
Type Description
int

The count of unreachable.

getUnreachableList()

public abstract List<String> getUnreachableList()

Locations that could not be reached.

repeated string unreachable = 3;

Returns
Type Description
List<String>

A list containing the unreachable.