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".
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:
The standard list page token.
Typically obtained via
[ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token]
of the previous
[PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs]
call.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThis documentation details the \u003ccode\u003eListPipelineJobsRequest\u003c/code\u003e class, which is used to request a list of Pipeline Jobs from the Vertex AI v1beta1 API.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListPipelineJobsRequest\u003c/code\u003e class implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, \u003ccode\u003eIBufferMessage\u003c/code\u003e, \u003ccode\u003eIPageRequest\u003c/code\u003e and inherits from \u003ccode\u003eobject\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe class allows for filtering of PipelineJobs based on various fields like \u003ccode\u003epipeline_name\u003c/code\u003e, \u003ccode\u003edisplay_name\u003c/code\u003e, \u003ccode\u003ecreate_time\u003c/code\u003e, and \u003ccode\u003elabels\u003c/code\u003e, offering support for logical operators in filter expressions.\u003c/p\u003e\n"],["\u003cp\u003eResults can be sorted using \u003ccode\u003eOrderBy\u003c/code\u003e, allowing for sorting by \u003ccode\u003ecreate_time\u003c/code\u003e, \u003ccode\u003eupdate_time\u003c/code\u003e, \u003ccode\u003eend_time\u003c/code\u003e, and \u003ccode\u003estart_time\u003c/code\u003e in ascending or descending order, and it supports pagination using \u003ccode\u003ePageSize\u003c/code\u003e and \u003ccode\u003ePageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003eParent\u003c/code\u003e field, which is the resource name of the location to list PipelineJobs from, and can have the \u003ccode\u003eReadMask\u003c/code\u003e property set to select specific fields.\u003c/p\u003e\n"]]],[],null,["# Vertex AI v1beta1 API - Class ListPipelineJobsRequest (1.0.0-beta47)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta47 (latest)](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ListPipelineJobsRequest)\n- [1.0.0-beta46](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/1.0.0-beta46/Google.Cloud.AIPlatform.V1Beta1.ListPipelineJobsRequest) \n\n public sealed class ListPipelineJobsRequest : IMessage\u003cListPipelineJobsRequest\u003e, IEquatable\u003cListPipelineJobsRequest\u003e, IDeepCloneable\u003cListPipelineJobsRequest\u003e, IBufferMessage, IMessage, IPageRequest\n\nReference documentation and code samples for the Vertex AI v1beta1 API class ListPipelineJobsRequest.\n\nRequest message for\n\\[PipelineService.ListPipelineJobs\\]\\[google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs\\]. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ListPipelineJobsRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ListPipelineJobsRequest](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ListPipelineJobsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ListPipelineJobsRequest](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ListPipelineJobsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ListPipelineJobsRequest](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ListPipelineJobsRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html), [IPageRequest](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.IPageRequest.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.AIPlatform.V1Beta1](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1)\n\nAssembly\n--------\n\nGoogle.Cloud.AIPlatform.V1Beta1.dll\n\nConstructors\n------------\n\n### ListPipelineJobsRequest()\n\n public ListPipelineJobsRequest()\n\n### ListPipelineJobsRequest(ListPipelineJobsRequest)\n\n public ListPipelineJobsRequest(ListPipelineJobsRequest other)\n\nProperties\n----------\n\n### Filter\n\n public string Filter { get; set; }\n\nLists the PipelineJobs that match the filter expression. The following\nfields are supported:\n\n- `pipeline_name`: Supports `=` and `!=` comparisons.\n- `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard.\n- `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\"*step*\"\n- `state`: Supports `=` and `!=` comparisons.\n- `create_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format.\n- `update_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format.\n- `end_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format.\n- `labels`: Supports key-value equality and key presence.\n- `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard.\n- `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard.\n\nFilter expressions can be combined together using logical operators\n(`AND` \\& `OR`).\nFor example: `pipeline_name=\"test\" AND create_time\u003e\"2020-05-18T13:30:00Z\"`.\n\nThe syntax to define filter expression is based on\n\u003chttps://google.aip.dev/160\u003e.\n\nExamples:\n\n- `create_time\u003e\"2021-05-18T00:00:00Z\" OR\n update_time\u003e\"2020-05-18T00:00:00Z\"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC.\n- `labels.env = \"prod\"` PipelineJobs with label \"env\" set to \"prod\".\n\n### OrderBy\n\n public string OrderBy { get; set; }\n\nA comma-separated list of fields to order by. The default sort order is in\nascending order. Use \"desc\" after a field name for descending. You can have\nmultiple order_by fields provided e.g. \"create_time desc, end_time\",\n\"end_time, start_time, update_time\" For example, using \"create_time desc,\nend_time\" will order results by create time in descending order, and if\nthere are multiple jobs having the same create time, order them by the end\ntime in ascending order. if order_by is not specified, it will order by\ndefault order is create time in descending order. Supported fields:\n\n- `create_time`\n- `update_time`\n- `end_time`\n- `start_time`\n\n### PageSize\n\n public int PageSize { get; set; }\n\nThe standard list page size.\n\n### PageToken\n\n public string PageToken { get; set; }\n\nThe standard list page token.\nTypically obtained via\n\\[ListPipelineJobsResponse.next_page_token\\]\\[google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token\\]\nof the previous\n\\[PipelineService.ListPipelineJobs\\]\\[google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs\\]\ncall.\n\n### Parent\n\n public string Parent { get; set; }\n\nRequired. The resource name of the Location to list the PipelineJobs from.\nFormat: `projects/{project}/locations/{location}`\n\n### ParentAsLocationName\n\n public LocationName ParentAsLocationName { get; set; }\n\n[LocationName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.LocationName.html)-typed view over the [Parent](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ListPipelineJobsRequest#Google_Cloud_AIPlatform_V1Beta1_ListPipelineJobsRequest_Parent) resource name property.\n\n### ReadMask\n\n public FieldMask ReadMask { get; set; }\n\nMask specifying which fields to read."]]
