Class ListJobsRequest.Builder (4.5.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListJobsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

build()

public ListJobsRequest build()
Returns
TypeDescription
ListJobsRequest

buildPartial()

public ListJobsRequest buildPartial()
Returns
TypeDescription
ListJobsRequest

clear()

public ListJobsRequest.Builder clear()
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

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
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ListJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

clone()

public ListJobsRequest.Builder clone()
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for clusterName.

getDefaultInstanceForType()

public ListJobsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListJobsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for region.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListJobsRequest other)

public ListJobsRequest.Builder mergeFrom(ListJobsRequest other)
Parameter
NameDescription
otherListJobsRequest
Returns
TypeDescription
ListJobsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListJobsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListJobsRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListJobsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

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
NameDescription
valueString

The clusterName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for clusterName to set.

Returns
TypeDescription
ListJobsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ListJobsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

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
NameDescription
valueString

The filter to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
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
NameDescription
valueListJobsRequest.JobStateMatcher

The jobStateMatcher to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for jobStateMatcher to set.

Returns
TypeDescription
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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
valueString

The projectId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for projectId to set.

Returns
TypeDescription
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
NameDescription
valueString

The region to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for region to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListJobsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListJobsRequest.Builder
Overrides