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
Namespace
Google \ Cloud \ Dataproc \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
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 |
string
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 |
getProjectId
Required. The ID of the Google Cloud Platform project that the job belongs to.
Returns | |
---|---|
Type | Description |
string |
setProjectId
Required. The ID of the Google Cloud Platform project that the job belongs to.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getRegion
Required. The Dataproc region in which to handle the request.
Returns | |
---|---|
Type | Description |
string |
setRegion
Required. The Dataproc region in which to handle the request.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
Optional. The number of results to return in each response.
Returns | |
---|---|
Type | Description |
int |
setPageSize
Optional. The number of results to return in each response.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
Optional. The page token, returned by a previous call, to request the next page of results.
Returns | |
---|---|
Type | Description |
string |
setPageToken
Optional. The page token, returned by a previous call, to request the next page of results.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getClusterName
Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
Returns | |
---|---|
Type | Description |
string |
setClusterName
Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getJobStateMatcher
Optional. Specifies enumerated categories of jobs to list.
(default = match ALL jobs).
If filter
is provided, jobStateMatcher
will be ignored.
Returns | |
---|---|
Type | Description |
int |
setJobStateMatcher
Optional. Specifies enumerated categories of jobs to list.
(default = match ALL jobs).
If filter
is provided, jobStateMatcher
will be ignored.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$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 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 = *
Returns | |
---|---|
Type | Description |
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 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 = *
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
projectId |
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\ListJobsRequest |
static::buildFromProjectIdRegionFilter
Parameters | |
---|---|
Name | Description |
projectId |
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. |
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 field is Example filter: status.state = ACTIVE AND labels.env = staging AND labels.starred = * |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\ListJobsRequest |