Class ListClustersResponse (0.16.0) 

public final class ListClustersResponse extends GeneratedMessageV3 implements ListClustersResponseOrBuilder

Response for ListClusters.

Protobuf type google.cloud.redis.cluster.v1.ListClustersResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListClustersResponse

Static Fields

CLUSTERS_FIELD_NUMBER

public static final int CLUSTERS_FIELD_NUMBER
Field Value
Type Description
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

UNREACHABLE_FIELD_NUMBER

public static final int UNREACHABLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListClustersResponse getDefaultInstance()
Returns
Type Description
ListClustersResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListClustersResponse.Builder newBuilder()
Returns
Type Description
ListClustersResponse.Builder

newBuilder(ListClustersResponse prototype)

public static ListClustersResponse.Builder newBuilder(ListClustersResponse prototype)
Parameter
Name Description
prototype ListClustersResponse
Returns
Type Description
ListClustersResponse.Builder

parseDelimitedFrom(InputStream input)

public static ListClustersResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListClustersResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListClustersResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListClustersResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListClustersResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListClustersResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListClustersResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListClustersResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListClustersResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListClustersResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListClustersResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListClustersResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListClustersResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListClustersResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListClustersResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListClustersResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListClustersResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListClustersResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListClustersResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListClustersResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListClustersResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListClustersResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListClustersResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListClustersResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListClustersResponse> parser()
Returns
Type Description
Parser<ListClustersResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getClusters(int index)

public Cluster getClusters(int index)

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

repeated .google.cloud.redis.cluster.v1.Cluster clusters = 1;

Parameter
Name Description
index int
Returns
Type Description
Cluster

getClustersCount()

public int getClustersCount()

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

repeated .google.cloud.redis.cluster.v1.Cluster clusters = 1;

Returns
Type Description
int

getClustersList()

public List<Cluster> getClustersList()

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

repeated .google.cloud.redis.cluster.v1.Cluster clusters = 1;

Returns
Type Description
List<Cluster>

getClustersOrBuilder(int index)

public ClusterOrBuilder getClustersOrBuilder(int index)

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

repeated .google.cloud.redis.cluster.v1.Cluster clusters = 1;

Parameter
Name Description
index int
Returns
Type Description
ClusterOrBuilder

getClustersOrBuilderList()

public List<? extends ClusterOrBuilder> getClustersOrBuilderList()

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

repeated .google.cloud.redis.cluster.v1.Cluster clusters = 1;

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

getDefaultInstanceForType()

public ListClustersResponse getDefaultInstanceForType()
Returns
Type Description
ListClustersResponse

getNextPageToken()

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

getParserForType()

public Parser<ListClustersResponse> getParserForType()
Returns
Type Description
Parser<ListClustersResponse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnreachable(int index)

public 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 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 int getUnreachableCount()

Locations that could not be reached.

repeated string unreachable = 3;

Returns
Type Description
int

The count of unreachable.

getUnreachableList()

public ProtocolStringList getUnreachableList()

Locations that could not be reached.

repeated string unreachable = 3;

Returns
Type Description
ProtocolStringList

A list containing the unreachable.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListClustersResponse.Builder newBuilderForType()
Returns
Type Description
ListClustersResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListClustersResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListClustersResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListClustersResponse.Builder toBuilder()
Returns
Type Description
ListClustersResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException