Lists jobs.
Arguments
Parameters | |
---|---|
parent |
Required. The location name. For example:
|
filter |
|
legacyAppEngineCron |
This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the jobs in the __cron queue will be listed instead.
|
pageSize |
Requested page size. The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist.
|
pageToken |
A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages.
|
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of ListJobsResponse
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- list: call: googleapis.cloudscheduler.v1beta1.projects.locations.jobs.list args: parent: ... filter: ... legacyAppEngineCron: ... pageSize: ... pageToken: ... result: listResult
JSON
[ { "list": { "call": "googleapis.cloudscheduler.v1beta1.projects.locations.jobs.list", "args": { "parent": "...", "filter": "...", "legacyAppEngineCron": "...", "pageSize": "...", "pageToken": "..." }, "result": "listResult" } } ]