Struct CancelControllerJobsRequest

pub struct CancelControllerJobsRequest {
    pub job_ids: Vec<String>,
    pub target: Option<Target>,
}

Cancel all given jobs that have yet to begin executing. This endpoint is not atomic, and will attempt to cancel every job even when some jobs cannot be canceled. A job can be canceled only if it has not yet started executing.

Success response indicates only that the request was received. Cancellation is not guaranteed, as it is based on job state at time of cancellation, and is completed on a best-effort basis.

Fields

job_ids: Vec<String>

target: Option<Target>

Required by ConServ gateway to forward requests to the correct rackhost.

Trait Implementations

impl Clone for CancelControllerJobsRequest

fn clone(&self) -> CancelControllerJobsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CancelControllerJobsRequest

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

Formats the value using the given formatter.

impl Default for CancelControllerJobsRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CancelControllerJobsRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for CancelControllerJobsRequest

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

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

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

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

impl PartialEq for CancelControllerJobsRequest

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

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 CancelControllerJobsRequest