Struct aws_sdk_iot::operation::cancel_job::builders::CancelJobInputBuilder

#[non_exhaustive]
pub struct CancelJobInputBuilder { /* private fields */ }

A builder for CancelJobInput.

Implementations

impl CancelJobInputBuilder

pub fn job_id(self, input: impl Into<String>) -> Self

The unique identifier you assigned to this job when it was created.

This field is required.

pub fn set_job_id(self, input: Option<String>) -> Self

The unique identifier you assigned to this job when it was created.

pub fn get_job_id(&self) -> &Option<String>

The unique identifier you assigned to this job when it was created.

pub fn reason_code(self, input: impl Into<String>) -> Self

(Optional)A reason code string that explains why the job was canceled.

pub fn set_reason_code(self, input: Option<String>) -> Self

(Optional)A reason code string that explains why the job was canceled.

pub fn get_reason_code(&self) -> &Option<String>

(Optional)A reason code string that explains why the job was canceled.

pub fn comment(self, input: impl Into<String>) -> Self

An optional comment string describing why the job was canceled.

pub fn set_comment(self, input: Option<String>) -> Self

An optional comment string describing why the job was canceled.

pub fn get_comment(&self) -> &Option<String>

An optional comment string describing why the job was canceled.

pub fn force(self, input: bool) -> Self

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

pub fn set_force(self, input: Option<bool>) -> Self

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

pub fn get_force(&self) -> &Option<bool>

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

pub fn build(self) -> Result<CancelJobInput, BuildError>

Consumes the builder and constructs a CancelJobInput.

impl CancelJobInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<CancelJobOutput, SdkError<CancelJobError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CancelJobInputBuilder

fn clone(&self) -> CancelJobInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CancelJobInputBuilder

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

Formats the value using the given formatter.

impl Default for CancelJobInputBuilder

fn default() -> CancelJobInputBuilder

Returns the “default value” for a type.

impl PartialEq for CancelJobInputBuilder

fn eq(&self, other: &CancelJobInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CancelJobInputBuilder