Class ListClustersRequest.Builder (0.17.0)

public static final class ListClustersRequest.Builder extends GeneratedMessageV3.Builder<ListClustersRequest.Builder> implements ListClustersRequestOrBuilder

Request for ListClusters.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListClustersRequest build()
Returns
Type Description
ListClustersRequest

buildPartial()

public ListClustersRequest buildPartial()
Returns
Type Description
ListClustersRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListClustersRequest.Builder clearPageSize()

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more clusters left to be queried.

int32 page_size = 2;

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

clearPageToken()

public ListClustersRequest.Builder clearPageToken()

The next_page_token value returned from a previous ListClusters request, if any.

string page_token = 3;

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

clearParent()

public ListClustersRequest.Builder clearParent()

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListClustersRequest getDefaultInstanceForType()
Returns
Type Description
ListClustersRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more clusters left to be queried.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

The next_page_token value returned from a previous ListClusters request, if any.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The next_page_token value returned from a previous ListClusters request, if any.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListClustersRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public ListClustersRequest.Builder setPageSize(int value)

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more clusters left to be queried.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListClustersRequest.Builder setPageToken(String value)

The next_page_token value returned from a previous ListClusters request, if any.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListClustersRequest.Builder setPageTokenBytes(ByteString value)

The next_page_token value returned from a previous ListClusters request, if any.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setParent(String value)

public ListClustersRequest.Builder setParent(String value)

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListClustersRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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