Struct DrainOptions

pub struct DrainOptions {
    pub drain_spec: Option<DrainSpec>,
    pub mark_eligible: bool,
    pub meta: HashMap<String, String>,
}

DrainOptions is used to pass through node drain parameters

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

Fields

drain_spec: Option<DrainSpec>

DrainSpec contains the drain specification for the node. If non-nil, the node will be marked ineligible and begin/continue draining according to the provided drain spec. If nil, any existing drain operation will be canceled.

mark_eligible: bool

MarkEligible indicates whether the node should be marked as eligible when canceling a drain operation.

meta: HashMap<String, String>

Meta is metadata that is persisted in Node.LastDrain about this drain update.

Trait Implementations

impl Clone for DrainOptions

fn clone(&self) -> DrainOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DrainOptions

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

Formats the value using the given formatter.

impl Default for DrainOptions

fn default() -> DrainOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DrainOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DrainOptions

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

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 DrainOptions