Class ListInstancesResponse.Builder (2.45.0)

public static final class ListInstancesResponse.Builder extends GeneratedMessageV3.Builder<ListInstancesResponse.Builder> implements ListInstancesResponseOrBuilder

Response for ListInstances.

Protobuf type google.cloud.redis.v1.ListInstancesResponse

Static Methods

getDescriptor()

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

Methods

addAllInstances(Iterable<? extends Instance> values)

public ListInstancesResponse.Builder addAllInstances(Iterable<? extends Instance> values)

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
values Iterable<? extends com.google.cloud.redis.v1.Instance>
Returns
Type Description
ListInstancesResponse.Builder

addAllUnreachable(Iterable<String> values)

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

This builder for chaining.

addInstances(Instance value)

public ListInstancesResponse.Builder addInstances(Instance value)

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
value Instance
Returns
Type Description
ListInstancesResponse.Builder

addInstances(Instance.Builder builderForValue)

public ListInstancesResponse.Builder addInstances(Instance.Builder builderForValue)

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
builderForValue Instance.Builder
Returns
Type Description
ListInstancesResponse.Builder

addInstances(int index, Instance value)

public ListInstancesResponse.Builder addInstances(int index, Instance value)

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;

Parameters
Name Description
index int
value Instance
Returns
Type Description
ListInstancesResponse.Builder

addInstances(int index, Instance.Builder builderForValue)

public ListInstancesResponse.Builder addInstances(int index, Instance.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Instance.Builder
Returns
Type Description
ListInstancesResponse.Builder

addInstancesBuilder()

public Instance.Builder addInstancesBuilder()

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

addInstancesBuilder(int index)

public Instance.Builder addInstancesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addUnreachable(String value)

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

This builder for chaining.

addUnreachableBytes(ByteString value)

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

This builder for chaining.

build()

public ListInstancesResponse build()
Returns
Type Description
ListInstancesResponse

buildPartial()

public ListInstancesResponse buildPartial()
Returns
Type Description
ListInstancesResponse

clear()

public ListInstancesResponse.Builder clear()
Returns
Type Description
ListInstancesResponse.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListInstancesResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListInstancesResponse.Builder
Overrides

clearInstances()

public ListInstancesResponse.Builder clearInstances()

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

clearNextPageToken()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearUnreachable()

public ListInstancesResponse.Builder clearUnreachable()

Locations that could not be reached.

repeated string unreachable = 3;

Returns
Type Description
ListInstancesResponse.Builder

This builder for chaining.

clone()

public ListInstancesResponse.Builder clone()
Returns
Type Description
ListInstancesResponse.Builder
Overrides

getDefaultInstanceForType()

public ListInstancesResponse getDefaultInstanceForType()
Returns
Type Description
ListInstancesResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInstances(int index)

public 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

getInstancesBuilder(int index)

public Instance.Builder getInstancesBuilder(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.Builder

getInstancesBuilderList()

public List<Instance.Builder> getInstancesBuilderList()

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

getInstancesCount()

public 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 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 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 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 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(ListInstancesResponse other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListInstancesResponse.Builder
Overrides

removeInstances(int index)

public ListInstancesResponse.Builder removeInstances(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
ListInstancesResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setInstances(int index, Instance value)

public ListInstancesResponse.Builder setInstances(int index, Instance value)

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;

Parameters
Name Description
index int
value Instance
Returns
Type Description
ListInstancesResponse.Builder

setInstances(int index, Instance.Builder builderForValue)

public ListInstancesResponse.Builder setInstances(int index, Instance.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Instance.Builder
Returns
Type Description
ListInstancesResponse.Builder

setNextPageToken(String value)

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

This builder for chaining.

setNextPageTokenBytes(ByteString value)

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

This builder for chaining.

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

public ListInstancesResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListInstancesResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListInstancesResponse.Builder
Overrides

setUnreachable(int index, String value)

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

This builder for chaining.