Package com.google.cloud.dataproc.v1

Interface ListJobsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListJobsRequest, ListJobsRequest.Builder

public interface ListJobsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
String	getClusterName()	Optional.
com.google.protobuf.ByteString	getClusterNameBytes()	Optional.
String	getFilter()	Optional.
com.google.protobuf.ByteString	getFilterBytes()	Optional.
ListJobsRequest.JobStateMatcher	getJobStateMatcher()	Optional.
int	getJobStateMatcherValue()	Optional.
int	getPageSize()	Optional.
String	getPageToken()	Optional.
com.google.protobuf.ByteString	getPageTokenBytes()	Optional.
String	getProjectId()	Required.
com.google.protobuf.ByteString	getProjectIdBytes()	Required.
String	getRegion()	Required.
com.google.protobuf.ByteString	getRegionBytes()	Required.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getProjectId

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:

The projectId.

getProjectIdBytes

com.google.protobuf.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:

The bytes for projectId.

getRegion

String getRegion()

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

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

Returns:

The region.

getRegionBytes

com.google.protobuf.ByteString getRegionBytes()

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

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

Returns:

The bytes for region.

getPageSize

int getPageSize()

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

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

Returns:

The pageSize.

getPageToken

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:

The pageToken.

getPageTokenBytes

com.google.protobuf.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:

The bytes for pageToken.

getClusterName

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:

The clusterName.

getClusterNameBytes

com.google.protobuf.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:

The bytes for clusterName.

getJobStateMatcherValue

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:

The enum numeric value on the wire for jobStateMatcher.

getJobStateMatcher

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:

The jobStateMatcher.

getFilter

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:

The filter.

getFilterBytes

com.google.protobuf.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:

The bytes for filter.