Class ListClustersResponse.Builder (0.5.0)

public static final class ListClustersResponse.Builder extends GeneratedMessageV3.Builder<ListClustersResponse.Builder> implements ListClustersResponseOrBuilder

Response for ListClusters.

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

Static Methods

getDescriptor()

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

Methods

addAllClusters(Iterable<? extends Cluster> values)

public ListClustersResponse.Builder addAllClusters(Iterable<? extends Cluster> values)

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
valuesIterable<? extends com.google.cloud.redis.cluster.v1.Cluster>
Returns
TypeDescription
ListClustersResponse.Builder

addAllUnreachable(Iterable<String> values)

public ListClustersResponse.Builder addAllUnreachable(Iterable<String> values)

Locations that could not be reached.

repeated string unreachable = 3;

Parameter
NameDescription
valuesIterable<String>

The unreachable to add.

Returns
TypeDescription
ListClustersResponse.Builder

This builder for chaining.

addClusters(Cluster value)

public ListClustersResponse.Builder addClusters(Cluster value)

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
valueCluster
Returns
TypeDescription
ListClustersResponse.Builder

addClusters(Cluster.Builder builderForValue)

public ListClustersResponse.Builder addClusters(Cluster.Builder builderForValue)

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
builderForValueCluster.Builder
Returns
TypeDescription
ListClustersResponse.Builder

addClusters(int index, Cluster value)

public ListClustersResponse.Builder addClusters(int index, Cluster value)

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;

Parameters
NameDescription
indexint
valueCluster
Returns
TypeDescription
ListClustersResponse.Builder

addClusters(int index, Cluster.Builder builderForValue)

public ListClustersResponse.Builder addClusters(int index, Cluster.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueCluster.Builder
Returns
TypeDescription
ListClustersResponse.Builder

addClustersBuilder()

public Cluster.Builder addClustersBuilder()

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
Cluster.Builder

addClustersBuilder(int index)

public Cluster.Builder addClustersBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListClustersResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListClustersResponse.Builder
Overrides

addUnreachable(String value)

public ListClustersResponse.Builder addUnreachable(String value)

Locations that could not be reached.

repeated string unreachable = 3;

Parameter
NameDescription
valueString

The unreachable to add.

Returns
TypeDescription
ListClustersResponse.Builder

This builder for chaining.

addUnreachableBytes(ByteString value)

public ListClustersResponse.Builder addUnreachableBytes(ByteString value)

Locations that could not be reached.

repeated string unreachable = 3;

Parameter
NameDescription
valueByteString

The bytes of the unreachable to add.

Returns
TypeDescription
ListClustersResponse.Builder

This builder for chaining.

build()

public ListClustersResponse build()
Returns
TypeDescription
ListClustersResponse

buildPartial()

public ListClustersResponse buildPartial()
Returns
TypeDescription
ListClustersResponse

clear()

public ListClustersResponse.Builder clear()
Returns
TypeDescription
ListClustersResponse.Builder
Overrides

clearClusters()

public ListClustersResponse.Builder clearClusters()

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
ListClustersResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public ListClustersResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListClustersResponse.Builder
Overrides

clearNextPageToken()

public ListClustersResponse.Builder clearNextPageToken()

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
ListClustersResponse.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListClustersResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListClustersResponse.Builder
Overrides

clearUnreachable()

public ListClustersResponse.Builder clearUnreachable()

Locations that could not be reached.

repeated string unreachable = 3;

Returns
TypeDescription
ListClustersResponse.Builder

This builder for chaining.

clone()

public ListClustersResponse.Builder clone()
Returns
TypeDescription
ListClustersResponse.Builder
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

getClustersBuilder(int index)

public Cluster.Builder getClustersBuilder(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.Builder

getClustersBuilderList()

public List<Cluster.Builder> getClustersBuilderList()

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<Builder>

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListClustersResponse other)

public ListClustersResponse.Builder mergeFrom(ListClustersResponse other)
Parameter
NameDescription
otherListClustersResponse
Returns
TypeDescription
ListClustersResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListClustersResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListClustersResponse.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListClustersResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListClustersResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListClustersResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListClustersResponse.Builder
Overrides

removeClusters(int index)

public ListClustersResponse.Builder removeClusters(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
ListClustersResponse.Builder

setClusters(int index, Cluster value)

public ListClustersResponse.Builder setClusters(int index, Cluster value)

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;

Parameters
NameDescription
indexint
valueCluster
Returns
TypeDescription
ListClustersResponse.Builder

setClusters(int index, Cluster.Builder builderForValue)

public ListClustersResponse.Builder setClusters(int index, Cluster.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueCluster.Builder
Returns
TypeDescription
ListClustersResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ListClustersResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListClustersResponse.Builder
Overrides

setNextPageToken(String value)

public ListClustersResponse.Builder setNextPageToken(String value)

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

string next_page_token = 2;

Parameter
NameDescription
valueString

The nextPageToken to set.

Returns
TypeDescription
ListClustersResponse.Builder

This builder for chaining.

setNextPageTokenBytes(ByteString value)

public ListClustersResponse.Builder setNextPageTokenBytes(ByteString value)

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

string next_page_token = 2;

Parameter
NameDescription
valueByteString

The bytes for nextPageToken to set.

Returns
TypeDescription
ListClustersResponse.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListClustersResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListClustersResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListClustersResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListClustersResponse.Builder
Overrides

setUnreachable(int index, String value)

public ListClustersResponse.Builder setUnreachable(int index, String value)

Locations that could not be reached.

repeated string unreachable = 3;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The unreachable to set.

Returns
TypeDescription
ListClustersResponse.Builder

This builder for chaining.