Struct JobStateTimeLimitAction

#[non_exhaustive]
pub struct JobStateTimeLimitAction {
    pub reason: Option<String>,
    pub state: Option<JobStateTimeLimitActionsState>,
    pub max_time_seconds: Option<i32>,
    pub action: Option<JobStateTimeLimitActionsAction>,
}

Specifies an action that Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.

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.

reason: Option<String>

The reason to log for the action being taken.

state: Option<JobStateTimeLimitActionsState>

The state of the job needed to trigger the action. The only supported value is RUNNABLE.

max_time_seconds: Option<i32>

The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).

action: Option<JobStateTimeLimitActionsAction>

The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL, which will cancel the job.

Implementations

impl JobStateTimeLimitAction

pub fn reason(&self) -> Option<&str>

The reason to log for the action being taken.

pub fn state(&self) -> Option<&JobStateTimeLimitActionsState>

The state of the job needed to trigger the action. The only supported value is RUNNABLE.

pub fn max_time_seconds(&self) -> Option<i32>

The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).

pub fn action(&self) -> Option<&JobStateTimeLimitActionsAction>

The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL, which will cancel the job.

impl JobStateTimeLimitAction

pub fn builder() -> JobStateTimeLimitActionBuilder

Creates a new builder-style object to manufacture JobStateTimeLimitAction.

Trait Implementations

impl Clone for JobStateTimeLimitAction

fn clone(&self) -> JobStateTimeLimitAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JobStateTimeLimitAction

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

Formats the value using the given formatter.

impl PartialEq for JobStateTimeLimitAction

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