Struct google_api_proto::google::cloud::scheduler::v1beta1::ListJobsRequest

pub struct ListJobsRequest {
    pub parent: String,
    pub filter: String,
    pub page_size: i32,
    pub page_token: String,
    pub legacy_app_engine_cron: bool,
}

Request message for listing jobs using [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs].

Fields

parent: String

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

filter: String

filter can be used to specify a subset of jobs.

If filter equals target_config="HttpConfig", then the http target jobs are retrieved. If filter equals target_config="PubSubConfig", then the Pub/Sub target jobs are retrieved. If filter equals labels.foo=value1 labels.foo=value2 then only jobs which are labeled with foo=value1 AND foo=value2 will be returned.

page_size: i32

Requested page size.

The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist.

page_token: String

A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of [next_page_token][google.cloud.scheduler.v1beta1.ListJobsResponse.next_page_token] returned from the previous call to [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. It is an error to switch the value of [filter][google.cloud.scheduler.v1beta1.ListJobsRequest.filter] or [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while iterating through pages.

legacy_app_engine_cron: bool

This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the jobs in the __cron queue will be listed instead.

Trait Implementations

impl Clone for ListJobsRequest

fn clone(&self) -> ListJobsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListJobsRequest

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

Formats the value using the given formatter.

impl Default for ListJobsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListJobsRequest

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 ListJobsRequest

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