- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListPipelineJobsRequest.
Request message for PipelineService.ListPipelineJobs .
Generated from protobuf message google.cloud.aiplatform.v1.ListPipelineJobsRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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".
↳ page_size
int
The standard list page size.
↳ page_token
string
The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.
↳ order_by
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
↳ read_mask
getParent
Required. The resource name of the Location to list the PipelineJobs from.
Format: projects/{project}/locations/{location}
string
setParent
Required. The resource name of the Location to list the PipelineJobs from.
Format: projects/{project}/locations/{location}
var
string
$this
getFilter
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".
string
setFilter
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".
var
string
$this
getPageSize
The standard list page size.
int
setPageSize
The standard list page size.
var
int
$this
getPageToken
The standard list page token.
Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.
string
setPageToken
The standard list page token.
Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.
var
string
$this
getOrderBy
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
string
setOrderBy
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
var
string
$this
getReadMask
Mask specifying which fields to read.
hasReadMask
clearReadMask
setReadMask
Mask specifying which fields to read.
$this
