Class ListClustersResponse (0.11.0)

public final class ListClustersResponse extends GeneratedMessageV3 implements ListClustersResponseOrBuilder

Response for ListClusters.

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

Static Fields

CLUSTERS_FIELD_NUMBER

public static final int CLUSTERS_FIELD_NUMBER
Field Value
TypeDescription
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

UNREACHABLE_FIELD_NUMBER

public static final int UNREACHABLE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ListClustersResponse getDefaultInstance()
Returns
TypeDescription
ListClustersResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ListClustersResponse.Builder newBuilder()
Returns
TypeDescription
ListClustersResponse.Builder

newBuilder(ListClustersResponse prototype)

public static ListClustersResponse.Builder newBuilder(ListClustersResponse prototype)
Parameter
NameDescription
prototypeListClustersResponse
Returns
TypeDescription
ListClustersResponse.Builder

parseDelimitedFrom(InputStream input)

public static ListClustersResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListClustersResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListClustersResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListClustersResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListClustersResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListClustersResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListClustersResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListClustersResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListClustersResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListClustersResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListClustersResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListClustersResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListClustersResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListClustersResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListClustersResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListClustersResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListClustersResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListClustersResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListClustersResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListClustersResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListClustersResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListClustersResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListClustersResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListClustersResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListClustersResponse> parser()
Returns
TypeDescription
Parser<ListClustersResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.redis.cluster.v1.ClusterOrBuilder>

getDefaultInstanceForType()

public ListClustersResponse getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for nextPageToken.

getParserForType()

public Parser<ListClustersResponse> getParserForType()
Returns
TypeDescription
Parser<ListClustersResponse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnreachable(int index)

public String getUnreachable(int index)

Locations that could not be reached.

repeated string unreachable = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
int

The count of unreachable.

getUnreachableList()

public ProtocolStringList getUnreachableList()

Locations that could not be reached.

repeated string unreachable = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the unreachable.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ListClustersResponse.Builder newBuilderForType()
Returns
TypeDescription
ListClustersResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListClustersResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListClustersResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ListClustersResponse.Builder toBuilder()
Returns
TypeDescription
ListClustersResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException