Class ProjectsResource.LocationsResource.PipelineJobsResource.ListRequest
Lists PipelineJobs in a Location.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1beta1
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.PipelineJobsResource.ListRequest : AiplatformBaseServiceRequest<GoogleCloudAiplatformV1beta1ListPipelineJobsResponse>, IClientServiceRequest<GoogleCloudAiplatformV1beta1ListPipelineJobsResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | parent |
Properties
Filter
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".
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
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 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
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type | Description |
---|---|
string |
PageSize
The standard list page size.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
Parent
Required. The resource name of the Location to list the PipelineJobs from. Format:
projects/{project}/locations/{location}
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type | Description |
---|---|
string |
ReadMask
Mask specifying which fields to read.
Declaration
[RequestParameter("readMask", RequestParameterType.Query)]
public virtual object ReadMask { get; set; }
Property Value
Type | Description |
---|---|
object |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()