1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::delete_job_execution::_delete_job_execution_output::DeleteJobExecutionOutputBuilder;
pub use crate::operation::delete_job_execution::_delete_job_execution_input::DeleteJobExecutionInputBuilder;
impl DeleteJobExecutionInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::delete_job_execution::DeleteJobExecutionOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::delete_job_execution::DeleteJobExecutionError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.delete_job_execution();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `DeleteJobExecution`.
///
/// <p>Deletes a job execution.</p>
/// <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteJobExecution</a> action.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct DeleteJobExecutionFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::delete_job_execution::builders::DeleteJobExecutionInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::delete_job_execution::DeleteJobExecutionOutput,
crate::operation::delete_job_execution::DeleteJobExecutionError,
> for DeleteJobExecutionFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::delete_job_execution::DeleteJobExecutionOutput,
crate::operation::delete_job_execution::DeleteJobExecutionError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl DeleteJobExecutionFluentBuilder {
/// Creates a new `DeleteJobExecution`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the DeleteJobExecution as a reference.
pub fn as_input(&self) -> &crate::operation::delete_job_execution::builders::DeleteJobExecutionInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::delete_job_execution::DeleteJobExecutionOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::delete_job_execution::DeleteJobExecutionError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::delete_job_execution::DeleteJobExecution::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::delete_job_execution::DeleteJobExecution::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::delete_job_execution::DeleteJobExecutionOutput,
crate::operation::delete_job_execution::DeleteJobExecutionError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The ID of the job whose execution on a particular device will be deleted.</p>
pub fn job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.job_id(input.into());
self
}
/// <p>The ID of the job whose execution on a particular device will be deleted.</p>
pub fn set_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_job_id(input);
self
}
/// <p>The ID of the job whose execution on a particular device will be deleted.</p>
pub fn get_job_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_job_id()
}
/// <p>The name of the thing whose job execution will be deleted.</p>
pub fn thing_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.thing_name(input.into());
self
}
/// <p>The name of the thing whose job execution will be deleted.</p>
pub fn set_thing_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_thing_name(input);
self
}
/// <p>The name of the thing whose job execution will be deleted.</p>
pub fn get_thing_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_thing_name()
}
/// <p>The ID of the job execution to be deleted. The <code>executionNumber</code> refers to the execution of a particular job on a particular device.</p>
/// <p>Note that once a job execution is deleted, the <code>executionNumber</code> may be reused by IoT, so be sure you get and use the correct value here.</p>
pub fn execution_number(mut self, input: i64) -> Self {
self.inner = self.inner.execution_number(input);
self
}
/// <p>The ID of the job execution to be deleted. The <code>executionNumber</code> refers to the execution of a particular job on a particular device.</p>
/// <p>Note that once a job execution is deleted, the <code>executionNumber</code> may be reused by IoT, so be sure you get and use the correct value here.</p>
pub fn set_execution_number(mut self, input: ::std::option::Option<i64>) -> Self {
self.inner = self.inner.set_execution_number(input);
self
}
/// <p>The ID of the job execution to be deleted. The <code>executionNumber</code> refers to the execution of a particular job on a particular device.</p>
/// <p>Note that once a job execution is deleted, the <code>executionNumber</code> may be reused by IoT, so be sure you get and use the correct value here.</p>
pub fn get_execution_number(&self) -> &::std::option::Option<i64> {
self.inner.get_execution_number()
}
/// <p>(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.</p> <note>
/// <p>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.</p>
/// </note>
pub fn force(mut self, input: bool) -> Self {
self.inner = self.inner.force(input);
self
}
/// <p>(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.</p> <note>
/// <p>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.</p>
/// </note>
pub fn set_force(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_force(input);
self
}
/// <p>(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.</p> <note>
/// <p>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.</p>
/// </note>
pub fn get_force(&self) -> &::std::option::Option<bool> {
self.inner.get_force()
}
/// <p>The namespace used to indicate that a job is a customer-managed job.</p>
/// <p>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.</p>
/// <p> <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code> </p> <note>
/// <p>The <code>namespaceId</code> feature is in public preview.</p>
/// </note>
pub fn namespace_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.namespace_id(input.into());
self
}
/// <p>The namespace used to indicate that a job is a customer-managed job.</p>
/// <p>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.</p>
/// <p> <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code> </p> <note>
/// <p>The <code>namespaceId</code> feature is in public preview.</p>
/// </note>
pub fn set_namespace_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_namespace_id(input);
self
}
/// <p>The namespace used to indicate that a job is a customer-managed job.</p>
/// <p>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.</p>
/// <p> <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code> </p> <note>
/// <p>The <code>namespaceId</code> feature is in public preview.</p>
/// </note>
pub fn get_namespace_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_namespace_id()
}
}