- 0.58.0 (latest)
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 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.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ListPipelineJobsRequest.
Request message for PipelineService.ListPipelineJobs.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
-
(::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".
#filter=
def filter=(value) -> ::String
-
value (::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".
-
(::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".
#order_by
def order_by() -> ::String
-
(::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
#order_by=
def order_by=(value) -> ::String
-
value (::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
-
(::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
#page_size
def page_size() -> ::Integer
- (::Integer) — The standard list page size.
#page_size=
def page_size=(value) -> ::Integer
- value (::Integer) — The standard list page size.
- (::Integer) — The standard list page size.
#page_token
def page_token() -> ::String
- (::String) — The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.
#page_token=
def page_token=(value) -> ::String
- value (::String) — The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.
- (::String) — The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.
#parent
def parent() -> ::String
-
(::String) — Required. The resource name of the Location to list the PipelineJobs from.
Format:
projects/{project}/locations/{location}
#parent=
def parent=(value) -> ::String
-
value (::String) — Required. The resource name of the Location to list the PipelineJobs from.
Format:
projects/{project}/locations/{location}
-
(::String) — Required. The resource name of the Location to list the PipelineJobs from.
Format:
projects/{project}/locations/{location}
#read_mask
def read_mask() -> ::Google::Protobuf::FieldMask
- (::Google::Protobuf::FieldMask) — Mask specifying which fields to read.
#read_mask=
def read_mask=(value) -> ::Google::Protobuf::FieldMask
- value (::Google::Protobuf::FieldMask) — Mask specifying which fields to read.
- (::Google::Protobuf::FieldMask) — Mask specifying which fields to read.