Struct aws_sdk_iot::operation::delete_job_execution::builders::DeleteJobExecutionInputBuilder

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

A builder for DeleteJobExecutionInput.

Implementations

impl DeleteJobExecutionInputBuilder

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.

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

The ID of the job whose execution on a particular device will be deleted.

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

The ID of the job whose execution on a particular device will be deleted.

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.

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

The name of the thing whose job execution will be deleted.

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

The name of the thing whose job execution will be deleted.

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.

This field is required.

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.

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.

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.

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.

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.

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.

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.

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.

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

Consumes the builder and constructs a DeleteJobExecutionInput.

impl DeleteJobExecutionInputBuilder

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

impl Clone for DeleteJobExecutionInputBuilder

fn clone(&self) -> DeleteJobExecutionInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteJobExecutionInputBuilder

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

Formats the value using the given formatter.

impl Default for DeleteJobExecutionInputBuilder

fn default() -> DeleteJobExecutionInputBuilder

Returns the “default value” for a type.

impl PartialEq for DeleteJobExecutionInputBuilder

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