Struct Scheduling

#[non_exhaustive]
pub struct Scheduling {
    pub timeout: Option<Duration>,
    pub restart_job_on_worker_restart: bool,
    pub strategy: Strategy,
    pub disable_retries: bool,
    pub max_wait_duration: Option<Duration>,
    /* private fields */
}

All parameters related to queuing and scheduling of custom jobs.

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.

timeout: Option<Duration>

Optional. The maximum job running time. The default is 7 days.

restart_job_on_worker_restart: bool

Optional. Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.

strategy: Strategy

Optional. This determines which type of scheduling strategy to use.

disable_retries: bool

Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides Scheduling.restart_job_on_worker_restart to false.

max_wait_duration: Option<Duration>

Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours.

Implementations

impl Scheduling

pub fn new() -> Self

pub fn set_timeout<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of timeout.

pub fn set_restart_job_on_worker_restart<T: Into<bool>>(self, v: T) -> Self

Sets the value of restart_job_on_worker_restart.

pub fn set_strategy<T: Into<Strategy>>(self, v: T) -> Self

Sets the value of strategy.

pub fn set_disable_retries<T: Into<bool>>(self, v: T) -> Self

Sets the value of disable_retries.

pub fn set_max_wait_duration<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of max_wait_duration.

Trait Implementations

impl Clone for Scheduling

fn clone(&self) -> Scheduling

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scheduling

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

Formats the value using the given formatter.

impl Default for Scheduling

fn default() -> Scheduling

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Scheduling

where Scheduling: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Scheduling

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Scheduling

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Scheduling