Class ListJobsRequest.Builder (4.38.0)

Version 4.38.0

• 4.50.0 (latest)
• 4.49.0
• 4.48.0
• 4.46.0
• 4.45.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.34.0
• 4.33.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.8
• 3.1.2
• 3.0.3
• 2.3.1

public static final class ListJobsRequest.Builder extends GeneratedMessageV3.Builder<ListJobsRequest.Builder> implements ListJobsRequestOrBuilder

A request to list jobs in a project.

Protobuf type google.cloud.dataproc.v1.ListJobsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListJobsRequest.Builder

Implements

ListJobsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListJobsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ListJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListJobsRequest build()

Returns
Type	Description
ListJobsRequest

buildPartial()

public ListJobsRequest buildPartial()

Returns
Type	Description
ListJobsRequest

clear()

public ListJobsRequest.Builder clear()

Returns
Type	Description
ListJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearClusterName()

public ListJobsRequest.Builder clearClusterName()

Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.

string cluster_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ListJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ListJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public ListJobsRequest.Builder clearFilter()

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

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

where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

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

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

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

clearJobStateMatcher()

public ListJobsRequest.Builder clearJobStateMatcher()

Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).

If filter is provided, jobStateMatcher will be ignored.

.google.cloud.dataproc.v1.ListJobsRequest.JobStateMatcher job_state_matcher = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ListJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPageSize()

public ListJobsRequest.Builder clearPageSize()

Optional. The number of results to return in each response.

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

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

clearPageToken()

public ListJobsRequest.Builder clearPageToken()

Optional. The page token, returned by a previous call, to request the next page of results.

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

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

clearProjectId()

public ListJobsRequest.Builder clearProjectId()

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

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

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

clearRegion()

public ListJobsRequest.Builder clearRegion()

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

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

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

clone()

public ListJobsRequest.Builder clone()

Returns
Type	Description
ListJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getClusterName()

public String getClusterName()

Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.

string cluster_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The clusterName.

getClusterNameBytes()

public ByteString getClusterNameBytes()

Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.

string cluster_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for clusterName.

getDefaultInstanceForType()

public ListJobsRequest getDefaultInstanceForType()

Returns
Type	Description
ListJobsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public String getFilter()

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

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

where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

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

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

Returns
Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

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

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

where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

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

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

Returns
Type	Description
ByteString	The bytes for filter.

getJobStateMatcher()

public ListJobsRequest.JobStateMatcher getJobStateMatcher()

Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).

If filter is provided, jobStateMatcher will be ignored.

.google.cloud.dataproc.v1.ListJobsRequest.JobStateMatcher job_state_matcher = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListJobsRequest.JobStateMatcher	The jobStateMatcher.

getJobStateMatcherValue()

public int getJobStateMatcherValue()

Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).

If filter is provided, jobStateMatcher will be ignored.

.google.cloud.dataproc.v1.ListJobsRequest.JobStateMatcher job_state_matcher = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for jobStateMatcher.

getPageSize()

public int getPageSize()

Optional. The number of results to return in each response.

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

Returns
Type	Description
int	The pageSize.

getPageToken()

public String getPageToken()

Optional. The page token, returned by a previous call, to request the next page of results.

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

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The page token, returned by a previous call, to request the next page of results.

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 job 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 job 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 = 6 [(.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 = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for region.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ListJobsRequest other)

public ListJobsRequest.Builder mergeFrom(ListJobsRequest other)

Parameter
Name	Description
other	ListJobsRequest

Returns
Type	Description
ListJobsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListJobsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListJobsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ListJobsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ListJobsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setClusterName(String value)

public ListJobsRequest.Builder setClusterName(String value)

Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.

string cluster_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The clusterName to set.

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

setClusterNameBytes(ByteString value)

public ListJobsRequest.Builder setClusterNameBytes(ByteString value)

Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.

string cluster_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for clusterName to set.

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ListJobsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ListJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public ListJobsRequest.Builder setFilter(String value)

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

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

where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

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

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

Parameter
Name	Description
value	String The filter to set.

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public ListJobsRequest.Builder setFilterBytes(ByteString value)

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

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

where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

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

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

Parameter
Name	Description
value	ByteString The bytes for filter to set.

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

setJobStateMatcher(ListJobsRequest.JobStateMatcher value)

public ListJobsRequest.Builder setJobStateMatcher(ListJobsRequest.JobStateMatcher value)

Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).

If filter is provided, jobStateMatcher will be ignored.

.google.cloud.dataproc.v1.ListJobsRequest.JobStateMatcher job_state_matcher = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ListJobsRequest.JobStateMatcher The jobStateMatcher to set.

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

setJobStateMatcherValue(int value)

public ListJobsRequest.Builder setJobStateMatcherValue(int value)

Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).

If filter is provided, jobStateMatcher will be ignored.

.google.cloud.dataproc.v1.ListJobsRequest.JobStateMatcher job_state_matcher = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for jobStateMatcher to set.

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

setPageSize(int value)

public ListJobsRequest.Builder setPageSize(int value)

Optional. The number of results to return in each response.

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

Parameter
Name	Description
value	int The pageSize to set.

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

setPageToken(String value)

public ListJobsRequest.Builder setPageToken(String value)

Optional. The page token, returned by a previous call, to request the next page of results.

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

Parameter
Name	Description
value	String The pageToken to set.

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListJobsRequest.Builder setPageTokenBytes(ByteString value)

Optional. The page token, returned by a previous call, to request the next page of results.

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

Parameter
Name	Description
value	ByteString The bytes for pageToken to set.

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

setProjectId(String value)

public ListJobsRequest.Builder setProjectId(String value)

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

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

Parameter
Name	Description
value	String The projectId to set.

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

setProjectIdBytes(ByteString value)

public ListJobsRequest.Builder setProjectIdBytes(ByteString value)

Required. The ID of the Google Cloud Platform project that the job 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
ListJobsRequest.Builder	This builder for chaining.

setRegion(String value)

public ListJobsRequest.Builder setRegion(String value)

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

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

Parameter
Name	Description
value	String The region to set.

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

setRegionBytes(ByteString value)

public ListJobsRequest.Builder setRegionBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for region to set.

Returns
Type	Description
ListJobsRequest.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
ListJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListJobsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)