public final class ListJobsRequest extends GeneratedMessageV3 implements ListJobsRequestOrBuilder
A request to list jobs in a project.
Protobuf type google.cloud.dataproc.v1.ListJobsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
CLUSTER_NAME_FIELD_NUMBER
public static final int CLUSTER_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
JOB_STATE_MATCHER_FIELD_NUMBER
public static final int JOB_STATE_MATCHER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROJECT_ID_FIELD_NUMBER
public static final int PROJECT_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ListJobsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListJobsRequest.Builder newBuilder()
newBuilder(ListJobsRequest prototype)
public static ListJobsRequest.Builder newBuilder(ListJobsRequest prototype)
public static ListJobsRequest parseDelimitedFrom(InputStream input)
public static ListJobsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListJobsRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListJobsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListJobsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListJobsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListJobsRequest parseFrom(CodedInputStream input)
public static ListJobsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListJobsRequest parseFrom(InputStream input)
public static ListJobsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListJobsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListJobsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListJobsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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()
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];
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()
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 |
|---|
| Type | Description |
ByteString | The bytes for region.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListJobsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListJobsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ListJobsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
