> [!WARNING]
>
> **Preview**
>
>
> This feature is
>
> subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
> [Service Specific
> Terms](https://docs.cloud.google.com/terms/service-terms#1).
>
> Pre-GA features are available "as is" and might have limited support.
>
> For more information, see the
> [launch stage descriptions](https://cloud.google.com/products/#product-launch-stages).

Lists PipelineJobs in a Location.

## Arguments

| Parameters ||
|---|---|
| `parent` | `string` Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}` |
| `filter` | `string` Lists the PipelineJobs that match the filter expression. The following fields are supported: \* `pipeline_name`: Supports `=` and `!=` comparisons. \* `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. \* `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\\"*step* \\" \* `state`: Supports `=` and `!=` comparisons. \* `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. \* `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. \* `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. \* `labels`: Supports key-value equality and key presence. \* `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. \* `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` \& `OR`). For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: \* `create_time>"2021-05-18T00:00:00Z" OR update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. \* `labels.env = "prod"` PipelineJobs with label "env" set to "prod". |
| `orderBy` | `string` 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 order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" 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 order_by is not specified, it will order by default order is create time in descending order. Supported fields: \* `create_time` \* `update_time` \* `end_time` \* `start_time` |
| `pageSize` | `integer (int32 format)` The standard list page size. |
| `pageToken` | `string` The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call. |
| `readMask` | `string (FieldMask format)` Mask specifying which fields to read. |
| `region` | `string` Required. Region of the HTTP endpoint. For example, if region is set to `us-central1`, the endpoint https://us-central1-integrations.googleapis.com will be used. See [service endpoints](https://cloud.google.com/vertex-ai/docs/reference/rest#rest_endpoints). |

## 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 [`GoogleCloudAiplatformV1beta1ListPipelineJobsResponse`](https://cloud.google.com/workflows/docs/reference/googleapis/aiplatform/v1beta1/Overview#GoogleCloudAiplatformV1beta1ListPipelineJobsResponse).

## Subworkflow snippet

Some fields might be optional or required.
To identify required fields, refer to the [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1beta1/projects.locations.pipelineJobs/list).

### YAML

```yaml
- list:
    call: googleapis.aiplatform.v1beta1.projects.locations.pipelineJobs.list
    args:
        parent: ...
        filter: ...
        orderBy: ...
        pageSize: ...
        pageToken: ...
        readMask: ...
        region: ...
    result: listResult
```

### JSON

```json
[
  {
    "list": {
      "call": "googleapis.aiplatform.v1beta1.projects.locations.pipelineJobs.list",
      "args": {
        "parent": "...",
        "filter": "...",
        "orderBy": "...",
        "pageSize": "...",
        "pageToken": "...",
        "readMask": "...",
        "region": "..."
      },
      "result": "listResult"
    }
  }
]
```