Class ListJobsRequest (4.3.0)
Version 4.3.0keyboard_arrow_down
public final class ListJobsRequest extends GeneratedMessageV3 implements ListJobsRequestOrBuilder
A request to list jobs in a project.
Protobuf type google.cloud.dataproc.v1.ListJobsRequest
Static Fields
CLUSTER_NAME_FIELD_NUMBER
public static final int CLUSTER_NAME_FIELD_NUMBER
Field Value
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
JOB_STATE_MATCHER_FIELD_NUMBER
public static final int JOB_STATE_MATCHER_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PROJECT_ID_FIELD_NUMBER
public static final int PROJECT_ID_FIELD_NUMBER
Field Value
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListJobsRequest getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static ListJobsRequest . Builder newBuilder ()
Returns
newBuilder(ListJobsRequest prototype)
public static ListJobsRequest . Builder newBuilder ( ListJobsRequest prototype )
Parameter
Returns
public static ListJobsRequest parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ListJobsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListJobsRequest parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListJobsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListJobsRequest parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListJobsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ListJobsRequest parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static ListJobsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ListJobsRequest parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ListJobsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListJobsRequest parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListJobsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<ListJobsRequest> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
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
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
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
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
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()
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.
getParserForType()
public Parser<ListJobsRequest> getParserForType ()
Returns
Overrides
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
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public ListJobsRequest . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListJobsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public ListJobsRequest . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
