ListJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A request to list jobs in a project.
Attributes
Name | Description |
project_id |
str
Required. The ID of the Google Cloud Platform project that the job belongs to. |
region |
str
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 |
str
Optional. The page token, returned by a previous call, to request the next page of results. |
cluster_name |
str
Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster. |
job_state_matcher |
google.cloud.dataproc_v1.types.ListJobsRequest.JobStateMatcher
Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs). If ``filter`` is provided, ``jobStateMatcher`` will be ignored. |
filter |
str
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 = \* |
Inheritance
builtins.object > proto.message.Message > ListJobsRequestClasses
JobStateMatcher
JobStateMatcher(value)
A matcher that specifies categories of job states.