Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::ListPipelineJobsRequest (v0.27.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
Returns
  • (::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
Parameter
  • 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".
Returns
  • (::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
Returns
  • (::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
Parameter
  • 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
Returns
  • (::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
Returns
  • (::Integer) — The standard list page size.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — The standard list page size.
Returns
  • (::Integer) — The standard list page size.

#page_token

def page_token() -> ::String
Returns

#page_token=

def page_token=(value) -> ::String
Parameter
Returns

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The resource name of the Location to list the PipelineJobs from. Format: projects/{project}/locations/{location}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the Location to list the PipelineJobs from. Format: projects/{project}/locations/{location}
Returns
  • (::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
Returns

#read_mask=

def read_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
Returns