Class ListClustersResponse.Builder (0.25.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
Type Description
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
Name Description
values Iterable<? extends com.google.cloud.redis.cluster.v1.Cluster>
Returns
Type Description
ListClustersResponse.Builder

addAllUnreachable(Iterable<String> values)

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

Locations that could not be reached.

repeated string unreachable = 3;

Parameter
Name Description
values Iterable<String>

The unreachable to add.

Returns
Type Description
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
Name Description
value Cluster
Returns
Type Description
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
Name Description
builderForValue Cluster.Builder
Returns
Type Description
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
Name Description
index int
value Cluster
Returns
Type Description
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
Name Description
index int
builderForValue Cluster.Builder
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
Cluster.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListClustersResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListClustersResponse.Builder
Overrides

addUnreachable(String value)

public ListClustersResponse.Builder addUnreachable(String value)

Locations that could not be reached.

repeated string unreachable = 3;

Parameter
Name Description
value String

The unreachable to add.

Returns
Type Description
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
Name Description
value ByteString

The bytes of the unreachable to add.

Returns
Type Description
ListClustersResponse.Builder

This builder for chaining.

build()

public ListClustersResponse build()
Returns
Type Description
ListClustersResponse

buildPartial()

public ListClustersResponse buildPartial()
Returns
Type Description
ListClustersResponse

clear()

public ListClustersResponse.Builder clear()
Returns
Type Description
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
Type Description
ListClustersResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public ListClustersResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
Type Description
ListClustersResponse.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListClustersResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListClustersResponse.Builder
Overrides

clearUnreachable()

public ListClustersResponse.Builder clearUnreachable()

Locations that could not be reached.

repeated string unreachable = 3;

Returns
Type Description
ListClustersResponse.Builder

This builder for chaining.

clone()

public ListClustersResponse.Builder clone()
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListClustersResponse other)

public ListClustersResponse.Builder mergeFrom(ListClustersResponse other)
Parameter
Name Description
other ListClustersResponse
Returns
Type Description
ListClustersResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListClustersResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListClustersResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListClustersResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListClustersResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListClustersResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
value Cluster
Returns
Type Description
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
Name Description
index int
builderForValue Cluster.Builder
Returns
Type Description
ListClustersResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ListClustersResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value String

The nextPageToken to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for nextPageToken to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListClustersResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListClustersResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
index int

The index to set the value at.

value String

The unreachable to set.

Returns
Type Description
ListClustersResponse.Builder

This builder for chaining.