Lists PipelineJobs in a Location.
HTTP request
GET https://{service-endpoint}/v1/{parent}/pipelineJobs
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the Location to list the PipelineJobs from. Format: |
Query parameters
Parameters | |
---|---|
filter |
Lists the PipelineJobs that match the filter expression. The following fields are supported:
Filter expressions can be combined together using logical operators ( The syntax to define filter expression is based on https://google.aip.dev/160. Examples:
|
pageSize |
The standard list page size. |
pageToken |
The standard list page token. Typically obtained via |
orderBy |
A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple orderBy fields provided e.g. "createTime desc, endTime", "endTime, startTime, updateTime" For example, using "createTime desc, endTime" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if orderBy is not specified, it will order by default order is create time in descending order. Supported fields:
|
readMask |
Mask specifying which fields to read. This is a comma-separated list of fully qualified names of fields. Example: |
Request body
The request body must be empty.
Response body
Response message for PipelineService.ListPipelineJobs
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"pipelineJobs": [
{
object ( |
Fields | |
---|---|
pipelineJobs[] |
List of PipelineJobs in the requested page. |
nextPageToken |
A token to retrieve the next page of results. Pass to |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
aiplatform.pipelineJobs.list
For more information, see the IAM documentation.