Lists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}.
Arguments
Parameters | |
---|---|
parent |
Required. The name of the project for which to list jobs. |
filter |
Optional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census': gcloud ai-platform jobs list --filter='jobId:census' List all failed jobs with names that start with 'rnn': gcloud ai-platform jobs list --filter='jobId:rnn AND state:FAILED' For more examples, see the guide to monitoring jobs. |
pageSize |
Optional. The number of jobs to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the |
pageToken |
Optional. A page token to request the next page of results. You get the token from the |
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 GoogleCloudMlV1__ListJobsResponse
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- list: call: googleapis.ml.v1.projects.jobs.list args: parent: ... filter: ... pageSize: ... pageToken: ... result: listResult
JSON
[ { "list": { "call": "googleapis.ml.v1.projects.jobs.list", "args": { "parent": "...", "filter": "...", "pageSize": "...", "pageToken": "..." }, "result": "listResult" } } ]