Struct aws_sdk_iot::operation::cancel_job_execution::builders::CancelJobExecutionInputBuilder
source · #[non_exhaustive]pub struct CancelJobExecutionInputBuilder { /* private fields */ }
Expand description
A builder for CancelJobExecutionInput
.
Implementations§
source§impl CancelJobExecutionInputBuilder
impl CancelJobExecutionInputBuilder
sourcepub fn job_id(self, input: impl Into<String>) -> Self
pub fn job_id(self, input: impl Into<String>) -> Self
The ID of the job to be canceled.
This field is required.sourcepub fn set_job_id(self, input: Option<String>) -> Self
pub fn set_job_id(self, input: Option<String>) -> Self
The ID of the job to be canceled.
sourcepub fn get_job_id(&self) -> &Option<String>
pub fn get_job_id(&self) -> &Option<String>
The ID of the job to be canceled.
sourcepub fn thing_name(self, input: impl Into<String>) -> Self
pub fn thing_name(self, input: impl Into<String>) -> Self
The name of the thing whose execution of the job will be canceled.
This field is required.sourcepub fn set_thing_name(self, input: Option<String>) -> Self
pub fn set_thing_name(self, input: Option<String>) -> Self
The name of the thing whose execution of the job will be canceled.
sourcepub fn get_thing_name(&self) -> &Option<String>
pub fn get_thing_name(&self) -> &Option<String>
The name of the thing whose execution of the job will be canceled.
sourcepub fn force(self, input: bool) -> Self
pub fn force(self, input: bool) -> Self
(Optional) If true
the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force
to true
, then an InvalidStateTransitionException
will be thrown. The default is false
.
Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
sourcepub fn set_force(self, input: Option<bool>) -> Self
pub fn set_force(self, input: Option<bool>) -> Self
(Optional) If true
the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force
to true
, then an InvalidStateTransitionException
will be thrown. The default is false
.
Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
sourcepub fn get_force(&self) -> &Option<bool>
pub fn get_force(&self) -> &Option<bool>
(Optional) If true
the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force
to true
, then an InvalidStateTransitionException
will be thrown. The default is false
.
Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
sourcepub fn expected_version(self, input: i64) -> Self
pub fn expected_version(self, input: i64) -> Self
(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
sourcepub fn set_expected_version(self, input: Option<i64>) -> Self
pub fn set_expected_version(self, input: Option<i64>) -> Self
(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
sourcepub fn get_expected_version(&self) -> &Option<i64>
pub fn get_expected_version(&self) -> &Option<i64>
(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
sourcepub fn status_details(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn status_details(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to status_details
.
To override the contents of this collection use set_status_details
.
A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.
sourcepub fn set_status_details(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_status_details(self, input: Option<HashMap<String, String>>) -> Self
A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.
sourcepub fn get_status_details(&self) -> &Option<HashMap<String, String>>
pub fn get_status_details(&self) -> &Option<HashMap<String, String>>
A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.
sourcepub fn build(self) -> Result<CancelJobExecutionInput, BuildError>
pub fn build(self) -> Result<CancelJobExecutionInput, BuildError>
Consumes the builder and constructs a CancelJobExecutionInput
.
source§impl CancelJobExecutionInputBuilder
impl CancelJobExecutionInputBuilder
sourcepub async fn send_with(
self,
client: &Client
) -> Result<CancelJobExecutionOutput, SdkError<CancelJobExecutionError, HttpResponse>>
pub async fn send_with( self, client: &Client ) -> Result<CancelJobExecutionOutput, SdkError<CancelJobExecutionError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for CancelJobExecutionInputBuilder
impl Clone for CancelJobExecutionInputBuilder
source§fn clone(&self) -> CancelJobExecutionInputBuilder
fn clone(&self) -> CancelJobExecutionInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for CancelJobExecutionInputBuilder
impl Default for CancelJobExecutionInputBuilder
source§fn default() -> CancelJobExecutionInputBuilder
fn default() -> CancelJobExecutionInputBuilder
source§impl PartialEq for CancelJobExecutionInputBuilder
impl PartialEq for CancelJobExecutionInputBuilder
source§fn eq(&self, other: &CancelJobExecutionInputBuilder) -> bool
fn eq(&self, other: &CancelJobExecutionInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CancelJobExecutionInputBuilder
Auto Trait Implementations§
impl Freeze for CancelJobExecutionInputBuilder
impl RefUnwindSafe for CancelJobExecutionInputBuilder
impl Send for CancelJobExecutionInputBuilder
impl Sync for CancelJobExecutionInputBuilder
impl Unpin for CancelJobExecutionInputBuilder
impl UnwindSafe for CancelJobExecutionInputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more