Struct google_api_proto::google::cloud::aiplatform::v1::ListPipelineJobsRequest

pub struct ListPipelineJobsRequest {
    pub parent: String,
    pub filter: String,
    pub page_size: i32,
    pub page_token: String,
    pub order_by: String,
    pub read_mask: Option<FieldMask>,
}

Request message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs].

Fields

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: i32

The standard list page size.

page_token: String

The standard list page token. Typically obtained via [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token] of the previous [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.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: Option<FieldMask>

Mask specifying which fields to read.

Trait Implementations

impl Clone for ListPipelineJobsRequest

fn clone(&self) -> ListPipelineJobsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListPipelineJobsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListPipelineJobsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListPipelineJobsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ListPipelineJobsRequest

fn eq(&self, other: &ListPipelineJobsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListPipelineJobsRequest