Struct ListSchedulesRequest 

#[non_exhaustive]
pub struct ListSchedulesRequest {
    pub parent: String,
    pub filter: String,
    pub page_size: i32,
    pub page_token: String,
    pub order_by: String,
    /* private fields */
}

Available on crate feature schedule-service only.

Request message for ScheduleService.ListSchedules.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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 of the previous 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

Implementations

impl ListSchedulesRequest

pub fn new() -> Self

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

Example

let x = ListSchedulesRequest::new().set_parent("example");

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

Example

let x = ListSchedulesRequest::new().set_filter("example");

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

Example

let x = ListSchedulesRequest::new().set_page_size(42);

pub fn set_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of page_token.

Example

let x = ListSchedulesRequest::new().set_page_token("example");

pub fn set_order_by<T: Into<String>>(self, v: T) -> Self

Sets the value of order_by.

Example

let x = ListSchedulesRequest::new().set_order_by("example");

Trait Implementations

impl Clone for ListSchedulesRequest

fn clone(&self) -> ListSchedulesRequest

Returns a duplicate 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() -> ListSchedulesRequest

Returns the “default value” for a type.

impl Message for ListSchedulesRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ListSchedulesRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ListSchedulesRequest