Struct google_api_proto::google::cloud::aiplatform::v1::ListSchedulesRequest

pub struct ListSchedulesRequest {
    pub parent: String,
    pub filter: String,
    pub page_size: i32,
    pub page_token: String,
    pub order_by: String,
}

Request message for [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules].

Fields

parent: String

Required. The resource name of the Location to list the Schedules from. Format: projects/{project}/locations/{location}

filter: String

Lists the Schedules that match the filter expression. The following fields are supported:

• display_name: Supports =, != comparisons, and : wildcard.
• state: Supports = and != comparisons.
• request: Supports existence of the <request_type> check. (e.g. create_pipeline_job_request:* –> Schedule has create_pipeline_job_request).
• create_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
• start_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
• end_time: Supports =, !=, <, >, <=, >= comparisons and :* existence check. Values must be in RFC 3339 format.
• next_run_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.

Filter expressions can be combined together using logical operators (NOT, AND & OR). The syntax to define filter expression is based on https://google.aip.dev/160.

Examples:

• state="ACTIVE" AND display_name:"my_schedule_*"
• NOT display_name="my_schedule"
• create_time>"2021-05-18T00:00:00Z"
• end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*
• create_pipeline_job_request:*

page_size: i32

The standard list page size. Default to 100 if not specified.

page_token: String

The standard list page token. Typically obtained via [ListSchedulesResponse.next_page_token][google.cloud.aiplatform.v1.ListSchedulesResponse.next_page_token] of the previous [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules] 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.

For example, using “create_time desc, end_time” will order results by create time in descending order, and if there are multiple schedules 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 with create_time in descending order.

Supported fields:

• create_time
• start_time
• end_time
• next_run_time

Trait Implementations

impl Clone for ListSchedulesRequest

fn clone(&self) -> ListSchedulesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListSchedulesRequest

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

Formats the value using the given formatter.

impl Default for ListSchedulesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListSchedulesRequest

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where 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( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where 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(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for ListSchedulesRequest

fn eq(&self, other: &ListSchedulesRequest) -> 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 ListSchedulesRequest