Class ListClustersRequest.Builder (4.50.0)

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

A request to list the clusters in a project.

Protobuf type google.cloud.dataproc.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

clearFilter()

public ListClustersRequest.Builder clearFilter()

Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:

field = value [AND [field = value]] ...

where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

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()

Optional. The standard List page size.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

clearPageToken()

public ListClustersRequest.Builder clearPageToken()

Optional. The standard List page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

clearProjectId()

public ListClustersRequest.Builder clearProjectId()

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

clearRegion()

public ListClustersRequest.Builder clearRegion()

Required. The Dataproc region in which to handle the request.

string region = 4 [(.google.api.field_behavior) = REQUIRED];

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

getFilter()

public String getFilter()

Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:

field = value [AND [field = value]] ...

where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:

field = value [AND [field = value]] ...

where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The standard List page size.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The standard List page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The standard List page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getProjectId()

public String getProjectId()

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for projectId.

getRegion()

public String getRegion()

Required. The Dataproc region in which to handle the request.

string region = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

Required. The Dataproc region in which to handle the request.

string region = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for region.

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

setFilter(String value)

public ListClustersRequest.Builder setFilter(String value)

Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:

field = value [AND [field = value]] ...

where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListClustersRequest.Builder setFilterBytes(ByteString value)

Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:

field = value [AND [field = value]] ...

where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListClustersRequest.Builder setPageSize(int value)

Optional. The standard List page size.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

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)

Optional. The standard List page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

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)

Optional. The standard List page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setProjectId(String value)

public ListClustersRequest.Builder setProjectId(String value)

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The projectId to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public ListClustersRequest.Builder setProjectIdBytes(ByteString value)

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for projectId to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setRegion(String value)

public ListClustersRequest.Builder setRegion(String value)

Required. The Dataproc region in which to handle the request.

string region = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The region to set.

Returns
Type Description
ListClustersRequest.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public ListClustersRequest.Builder setRegionBytes(ByteString value)

Required. The Dataproc region in which to handle the request.

string region = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for region 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