Reference documentation and code samples for the Google Cloud Dataproc V1 Client class ListJobsRequest.
A request to list jobs in a project.
Generated from protobuf message google.cloud.dataproc.v1.ListJobsRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ project_id
string
Required. The ID of the Google Cloud Platform project that the job belongs to.
↳ region
string
Required. The Dataproc region in which to handle the request.
↳ page_size
int
Optional. The number of results to return in each response.
↳ page_token
string
Optional. The page token, returned by a previous call, to request the next page of results.
↳ cluster_name
string
Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
↳ job_state_matcher
int
Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs). If filter
is provided, jobStateMatcher
will be ignored.
↳ filter
string
Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax: [field = value] AND [field [= value]] ... where fieldis status.state
or labels.[KEY]
, and [KEY]
is a label key. valuecan 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 = *
getProjectId
Required. The ID of the Google Cloud Platform project that the job belongs to.
Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
string
setProjectId
Required. The ID of the Google Cloud Platform project that the job belongs to.
Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getRegion
Required. The Dataproc region in which to handle the request.
Generated from protobuf field string region = 6 [(.google.api.field_behavior) = REQUIRED];
string
setRegion
Required. The Dataproc region in which to handle the request.
Generated from protobuf field string region = 6 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getPageSize
Optional. The number of results to return in each response.
Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
int
setPageSize
Optional. The number of results to return in each response.
Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
var
int
$this
getPageToken
Optional. The page token, returned by a previous call, to request the next page of results.
Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
string
setPageToken
Optional. The page token, returned by a previous call, to request the next page of results.
Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getClusterName
Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
Generated from protobuf field string cluster_name = 4 [(.google.api.field_behavior) = OPTIONAL];
string
setClusterName
Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
Generated from protobuf field string cluster_name = 4 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getJobStateMatcher
Optional. Specifies enumerated categories of jobs to list.
(default = match ALL jobs).
If filter
is provided, jobStateMatcher
will be ignored.
Generated from protobuf field .google.cloud.dataproc.v1.ListJobsRequest.JobStateMatcher job_state_matcher = 5 [(.google.api.field_behavior) = OPTIONAL];
int
setJobStateMatcher
Optional. Specifies enumerated categories of jobs to list.
(default = match ALL jobs).
If filter
is provided, jobStateMatcher
will be ignored.
Generated from protobuf field .google.cloud.dataproc.v1.ListJobsRequest.JobStateMatcher job_state_matcher = 5 [(.google.api.field_behavior) = OPTIONAL];
var
int
$this
getFilter
Optional. A filter constraining the jobs to list. Filters are
case-sensitive and have the following syntax:
[field = value] AND [field [= value]] ...
where fieldis status.state
or labels.[KEY]
, and [KEY]
is a label
key. valuecan 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 = *
Generated from protobuf field string filter = 7 [(.google.api.field_behavior) = OPTIONAL];
string
setFilter
Optional. A filter constraining the jobs to list. Filters are
case-sensitive and have the following syntax:
[field = value] AND [field [= value]] ...
where fieldis status.state
or labels.[KEY]
, and [KEY]
is a label
key. valuecan 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 = *
Generated from protobuf field string filter = 7 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
