Struct aws_sdk_iot::operation::delete_job_execution::builders::DeleteJobExecutionInputBuilder
source · #[non_exhaustive]pub struct DeleteJobExecutionInputBuilder { /* private fields */ }
Expand description
A builder for DeleteJobExecutionInput
.
Implementations§
source§impl DeleteJobExecutionInputBuilder
impl DeleteJobExecutionInputBuilder
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 whose execution on a particular device will be deleted.
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 whose execution on a particular device will be deleted.
sourcepub fn get_job_id(&self) -> &Option<String>
pub fn get_job_id(&self) -> &Option<String>
The ID of the job whose execution on a particular device will be deleted.
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 job execution will be deleted.
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 job execution will be deleted.
sourcepub fn get_thing_name(&self) -> &Option<String>
pub fn get_thing_name(&self) -> &Option<String>
The name of the thing whose job execution will be deleted.
sourcepub fn execution_number(self, input: i64) -> Self
pub fn execution_number(self, input: i64) -> Self
The ID of the job execution to be deleted. The executionNumber
refers to the execution of a particular job on a particular device.
Note that once a job execution is deleted, the executionNumber
may be reused by IoT, so be sure you get and use the correct value here.
sourcepub fn set_execution_number(self, input: Option<i64>) -> Self
pub fn set_execution_number(self, input: Option<i64>) -> Self
The ID of the job execution to be deleted. The executionNumber
refers to the execution of a particular job on a particular device.
Note that once a job execution is deleted, the executionNumber
may be reused by IoT, so be sure you get and use the correct value here.
sourcepub fn get_execution_number(&self) -> &Option<i64>
pub fn get_execution_number(&self) -> &Option<i64>
The ID of the job execution to be deleted. The executionNumber
refers to the execution of a particular job on a particular device.
Note that once a job execution is deleted, the executionNumber
may be reused by IoT, so be sure you get and use the correct value here.
sourcepub fn force(self, input: bool) -> Self
pub fn force(self, input: bool) -> Self
(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.
Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or 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) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.
Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or 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) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.
Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
sourcepub fn namespace_id(self, input: impl Into<String>) -> Self
pub fn namespace_id(self, input: impl Into<String>) -> Self
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
sourcepub fn set_namespace_id(self, input: Option<String>) -> Self
pub fn set_namespace_id(self, input: Option<String>) -> Self
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
sourcepub fn get_namespace_id(&self) -> &Option<String>
pub fn get_namespace_id(&self) -> &Option<String>
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
sourcepub fn build(self) -> Result<DeleteJobExecutionInput, BuildError>
pub fn build(self) -> Result<DeleteJobExecutionInput, BuildError>
Consumes the builder and constructs a DeleteJobExecutionInput
.
source§impl DeleteJobExecutionInputBuilder
impl DeleteJobExecutionInputBuilder
sourcepub async fn send_with(
self,
client: &Client
) -> Result<DeleteJobExecutionOutput, SdkError<DeleteJobExecutionError, HttpResponse>>
pub async fn send_with( self, client: &Client ) -> Result<DeleteJobExecutionOutput, SdkError<DeleteJobExecutionError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for DeleteJobExecutionInputBuilder
impl Clone for DeleteJobExecutionInputBuilder
source§fn clone(&self) -> DeleteJobExecutionInputBuilder
fn clone(&self) -> DeleteJobExecutionInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for DeleteJobExecutionInputBuilder
impl Default for DeleteJobExecutionInputBuilder
source§fn default() -> DeleteJobExecutionInputBuilder
fn default() -> DeleteJobExecutionInputBuilder
source§impl PartialEq for DeleteJobExecutionInputBuilder
impl PartialEq for DeleteJobExecutionInputBuilder
source§fn eq(&self, other: &DeleteJobExecutionInputBuilder) -> bool
fn eq(&self, other: &DeleteJobExecutionInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for DeleteJobExecutionInputBuilder
Auto Trait Implementations§
impl Freeze for DeleteJobExecutionInputBuilder
impl RefUnwindSafe for DeleteJobExecutionInputBuilder
impl Send for DeleteJobExecutionInputBuilder
impl Sync for DeleteJobExecutionInputBuilder
impl Unpin for DeleteJobExecutionInputBuilder
impl UnwindSafe for DeleteJobExecutionInputBuilder
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