Struct DeregisterOptions 

pub struct DeregisterOptions {
    pub purge: bool,
    pub global: bool,
    pub eval_priority: i64,
    pub no_shutdown_delay: bool,
}

DeregisterOptions is used to pass through job deregistration parameters

This struct was generated based on the Go types of the official Nomad API client.

Fields

purge: bool

If Purge is set to true, the job is deregistered and purged from the system versus still being queryable and eventually GC’ed from the system. Most callers should not specify purge.

global: bool

If Global is set to true, all regions of a multiregion job will be stopped.

eval_priority: i64

EvalPriority is an optional priority to use on any evaluation created as a result on this job deregistration. This value must be between 1-100 inclusively, where a larger value corresponds to a higher priority. This is useful when an operator wishes to push through a job deregistration in busy clusters with a large evaluation backlog.

no_shutdown_delay: bool

NoShutdownDelay, if set to true, will override the group and task shutdown_delay configuration and ignore the delay for any allocations stopped as a result of this Deregister call.

Implementations

impl DeregisterOptions

pub fn builder() -> DeregisterOptionsBuilder

Trait Implementations

impl Clone for DeregisterOptions

fn clone(&self) -> DeregisterOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeregisterOptions

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

Formats the value using the given formatter.

impl Default for DeregisterOptions

fn default() -> DeregisterOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DeregisterOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DeregisterOptions

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

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 DeregisterOptions