Interface ListJobsRequestOrBuilder (4.29.0)

Version 4.29.0

• 4.52.0 (latest)
• 4.51.0
• 4.50.0
• 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 interface ListJobsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getClusterName()

public abstract 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 abstract 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.

getFilter()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.