Struct googapis::google::cloud::scheduler::v1beta1::Job

pub struct Job {
    pub name: String,
    pub description: String,
    pub schedule: String,
    pub time_zone: String,
    pub user_update_time: Option<Timestamp>,
    pub state: i32,
    pub status: Option<Status>,
    pub schedule_time: Option<Timestamp>,
    pub last_attempt_time: Option<Timestamp>,
    pub retry_config: Option<RetryConfig>,
    pub attempt_deadline: Option<Duration>,
    pub target: Option<Target>,
}

Configuration for a job. The maximum allowed size for a job is 100KB.

Fields

name: String

Optionally caller-specified in [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob], after which it becomes output only.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

• PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
• LOCATION_ID is the canonical ID for the job’s location. The list of available locations can be obtained by calling [ListLocations][google.cloud.location.Locations.ListLocations]. For more information, see https://cloud.google.com/about/locations/.
• JOB_ID can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.

description: String

Optionally caller-specified in [CreateJob][google.cloud.scheduler.v1beta1.CloudScheduler.CreateJob] or [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob].

A human-readable description for the job. This string must not contain more than 500 characters.

schedule: String

Required, except when used with [UpdateJob][google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJob].

Describes the schedule on which the job will be executed.

The schedule can be either of the following types:

• [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)
• English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

As a general rule, execution n + 1 of a job will not begin until execution n has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the n+1th execution is scheduled to run at 16:00 but the nth execution takes until 16:15, the n+1th execution will not start until 16:15. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs.

If [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] > 0 and a job attempt fails, the job will be tried a total of [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count] times, with exponential backoff, until the next scheduled start time.

time_zone: String

Specifies the time zone to be used in interpreting [schedule][google.cloud.scheduler.v1beta1.Job.schedule]. The value of this field must be a time zone name from the tz database.

Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string “utc”. If a time zone is not specified, the default will be in UTC (also known as GMT).

user_update_time: Option<Timestamp>

Output only. The creation time of the job.

state: i32

Output only. State of the job.

status: Option<Status>

Output only. The response from the target for the last attempted execution.

schedule_time: Option<Timestamp>

Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.

last_attempt_time: Option<Timestamp>

Output only. The time the last job attempt started.

retry_config: Option<RetryConfig>

Settings that determine the retry behavior.

attempt_deadline: Option<Duration>

The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the [RetryConfig][google.cloud.scheduler.v1beta1.RetryConfig].

The allowed duration for this deadline is:

• For [HTTP targets][google.cloud.scheduler.v1beta1.Job.http_target], between 15 seconds and 30 minutes.
• For [App Engine HTTP targets][google.cloud.scheduler.v1beta1.Job.app_engine_http_target], between 15 seconds and 24 hours.
• For [PubSub targets][google.cloud.scheduler.v1beta1.Job.pubsub_target], this field is ignored.

target: Option<Target>

Required.

Delivery settings containing destination and parameters.

Implementations

impl Job

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

Trait Implementations

impl Clone for Job

fn clone(&self) -> Job

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Job

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

Formats the value using the given formatter.

impl Default for Job

fn default() -> Self

Returns the “default value” for a type.

impl Message for Job

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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, 

Encodes the message to a buffer.

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

Encodes the message to a newly allocated buffer.

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

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

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

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

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

Decodes an instance of the message from a buffer.

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

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

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

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, 

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

impl PartialEq<Job> for Job

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

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

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

This method tests for !=.

impl StructuralPartialEq for Job