aws_sdk_iot/operation/cancel_job/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::cancel_job::_cancel_job_output::CancelJobOutputBuilder;
3
4pub use crate::operation::cancel_job::_cancel_job_input::CancelJobInputBuilder;
5
6impl crate::operation::cancel_job::builders::CancelJobInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::cancel_job::CancelJobOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::cancel_job::CancelJobError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.cancel_job();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CancelJob`.
24///
25/// <p>Cancels a job.</p>
26/// <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelJob</a> action.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct CancelJobFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::cancel_job::builders::CancelJobInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl crate::client::customize::internal::CustomizableSend<crate::operation::cancel_job::CancelJobOutput, crate::operation::cancel_job::CancelJobError>
34    for CancelJobFluentBuilder
35{
36    fn send(
37        self,
38        config_override: crate::config::Builder,
39    ) -> crate::client::customize::internal::BoxFuture<
40        crate::client::customize::internal::SendResult<crate::operation::cancel_job::CancelJobOutput, crate::operation::cancel_job::CancelJobError>,
41    > {
42        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
43    }
44}
45impl CancelJobFluentBuilder {
46    /// Creates a new `CancelJobFluentBuilder`.
47    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
48        Self {
49            handle,
50            inner: ::std::default::Default::default(),
51            config_override: ::std::option::Option::None,
52        }
53    }
54    /// Access the CancelJob as a reference.
55    pub fn as_input(&self) -> &crate::operation::cancel_job::builders::CancelJobInputBuilder {
56        &self.inner
57    }
58    /// Sends the request and returns the response.
59    ///
60    /// If an error occurs, an `SdkError` will be returned with additional details that
61    /// can be matched against.
62    ///
63    /// By default, any retryable failures will be retried twice. Retry behavior
64    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
65    /// set when configuring the client.
66    pub async fn send(
67        self,
68    ) -> ::std::result::Result<
69        crate::operation::cancel_job::CancelJobOutput,
70        ::aws_smithy_runtime_api::client::result::SdkError<
71            crate::operation::cancel_job::CancelJobError,
72            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
73        >,
74    > {
75        let input = self
76            .inner
77            .build()
78            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
79        let runtime_plugins = crate::operation::cancel_job::CancelJob::operation_runtime_plugins(
80            self.handle.runtime_plugins.clone(),
81            &self.handle.conf,
82            self.config_override,
83        );
84        crate::operation::cancel_job::CancelJob::orchestrate(&runtime_plugins, input).await
85    }
86
87    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
88    pub fn customize(
89        self,
90    ) -> crate::client::customize::CustomizableOperation<
91        crate::operation::cancel_job::CancelJobOutput,
92        crate::operation::cancel_job::CancelJobError,
93        Self,
94    > {
95        crate::client::customize::CustomizableOperation::new(self)
96    }
97    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
98        self.set_config_override(::std::option::Option::Some(config_override.into()));
99        self
100    }
101
102    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
103        self.config_override = config_override;
104        self
105    }
106    /// <p>The unique identifier you assigned to this job when it was created.</p>
107    pub fn job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
108        self.inner = self.inner.job_id(input.into());
109        self
110    }
111    /// <p>The unique identifier you assigned to this job when it was created.</p>
112    pub fn set_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
113        self.inner = self.inner.set_job_id(input);
114        self
115    }
116    /// <p>The unique identifier you assigned to this job when it was created.</p>
117    pub fn get_job_id(&self) -> &::std::option::Option<::std::string::String> {
118        self.inner.get_job_id()
119    }
120    /// <p>(Optional)A reason code string that explains why the job was canceled.</p>
121    pub fn reason_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
122        self.inner = self.inner.reason_code(input.into());
123        self
124    }
125    /// <p>(Optional)A reason code string that explains why the job was canceled.</p>
126    pub fn set_reason_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
127        self.inner = self.inner.set_reason_code(input);
128        self
129    }
130    /// <p>(Optional)A reason code string that explains why the job was canceled.</p>
131    pub fn get_reason_code(&self) -> &::std::option::Option<::std::string::String> {
132        self.inner.get_reason_code()
133    }
134    /// <p>An optional comment string describing why the job was canceled.</p>
135    pub fn comment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
136        self.inner = self.inner.comment(input.into());
137        self
138    }
139    /// <p>An optional comment string describing why the job was canceled.</p>
140    pub fn set_comment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
141        self.inner = self.inner.set_comment(input);
142        self
143    }
144    /// <p>An optional comment string describing why the job was canceled.</p>
145    pub fn get_comment(&self) -> &::std::option::Option<::std::string::String> {
146        self.inner.get_comment()
147    }
148    /// <p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is <code>false</code>.</p>
149    /// <p>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.</p>
150    pub fn force(mut self, input: bool) -> Self {
151        self.inner = self.inner.force(input);
152        self
153    }
154    /// <p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is <code>false</code>.</p>
155    /// <p>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.</p>
156    pub fn set_force(mut self, input: ::std::option::Option<bool>) -> Self {
157        self.inner = self.inner.set_force(input);
158        self
159    }
160    /// <p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is <code>false</code>.</p>
161    /// <p>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.</p>
162    pub fn get_force(&self) -> &::std::option::Option<bool> {
163        self.inner.get_force()
164    }
165}
aws_sdk_iot/operation/cancel_job/builders.rs

aws_sdk_iot/operation/cancel_job/
builders.rs
