Struct aws_sdk_iot::input::CancelJobInput
source · [−]#[non_exhaustive]pub struct CancelJobInput {
pub job_id: Option<String>,
pub reason_code: Option<String>,
pub comment: Option<String>,
pub force: bool,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.job_id: Option<String>
The unique identifier you assigned to this job when it was created.
reason_code: Option<String>
(Optional)A reason code string that explains why the job was canceled.
comment: Option<String>
An optional comment string describing why the job was canceled.
force: 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.
Implementations
sourceimpl CancelJobInput
impl CancelJobInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CancelJob, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CancelJob, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CancelJob
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CancelJobInput
sourceimpl CancelJobInput
impl CancelJobInput
sourcepub fn job_id(&self) -> Option<&str>
pub fn job_id(&self) -> Option<&str>
The unique identifier you assigned to this job when it was created.
sourcepub fn reason_code(&self) -> Option<&str>
pub fn reason_code(&self) -> Option<&str>
(Optional)A reason code string that explains why the job was canceled.
sourcepub fn comment(&self) -> Option<&str>
pub fn comment(&self) -> Option<&str>
An optional comment string describing why the job was canceled.
sourcepub fn force(&self) -> bool
pub fn force(&self) -> 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.
Trait Implementations
sourceimpl Clone for CancelJobInput
impl Clone for CancelJobInput
sourcefn clone(&self) -> CancelJobInput
fn clone(&self) -> CancelJobInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CancelJobInput
impl Debug for CancelJobInput
sourceimpl PartialEq<CancelJobInput> for CancelJobInput
impl PartialEq<CancelJobInput> for CancelJobInput
sourcefn eq(&self, other: &CancelJobInput) -> bool
fn eq(&self, other: &CancelJobInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CancelJobInput) -> bool
fn ne(&self, other: &CancelJobInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for CancelJobInput
Auto Trait Implementations
impl RefUnwindSafe for CancelJobInput
impl Send for CancelJobInput
impl Sync for CancelJobInput
impl Unpin for CancelJobInput
impl UnwindSafe for CancelJobInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more