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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::cancel_job::_cancel_job_output::CancelJobOutputBuilder;
pub use crate::operation::cancel_job::_cancel_job_input::CancelJobInputBuilder;
impl crate::operation::cancel_job::builders::CancelJobInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::cancel_job::CancelJobOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::cancel_job::CancelJobError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.cancel_job();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `CancelJob`.
///
/// <p>Cancels a job.</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">CancelJob</a> action.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CancelJobFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::cancel_job::builders::CancelJobInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl crate::client::customize::internal::CustomizableSend<crate::operation::cancel_job::CancelJobOutput, crate::operation::cancel_job::CancelJobError>
for CancelJobFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<crate::operation::cancel_job::CancelJobOutput, crate::operation::cancel_job::CancelJobError>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl CancelJobFluentBuilder {
/// Creates a new `CancelJobFluentBuilder`.
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 CancelJob as a reference.
pub fn as_input(&self) -> &crate::operation::cancel_job::builders::CancelJobInputBuilder {
&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::cancel_job::CancelJobOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::cancel_job::CancelJobError,
::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::cancel_job::CancelJob::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::cancel_job::CancelJob::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::cancel_job::CancelJobOutput,
crate::operation::cancel_job::CancelJobError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The unique identifier you assigned to this job when it was created.</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 unique identifier you assigned to this job when it was created.</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 unique identifier you assigned to this job when it was created.</p>
pub fn get_job_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_job_id()
}
/// <p>(Optional)A reason code string that explains why the job was canceled.</p>
pub fn reason_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.reason_code(input.into());
self
}
/// <p>(Optional)A reason code string that explains why the job was canceled.</p>
pub fn set_reason_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_reason_code(input);
self
}
/// <p>(Optional)A reason code string that explains why the job was canceled.</p>
pub fn get_reason_code(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_reason_code()
}
/// <p>An optional comment string describing why the job was canceled.</p>
pub fn comment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.comment(input.into());
self
}
/// <p>An optional comment string describing why the job was canceled.</p>
pub fn set_comment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_comment(input);
self
}
/// <p>An optional comment string describing why the job was canceled.</p>
pub fn get_comment(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_comment()
}
/// <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>
/// <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>
pub fn force(mut self, input: bool) -> Self {
self.inner = self.inner.force(input);
self
}
/// <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>
/// <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>
pub fn set_force(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_force(input);
self
}
/// <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>
/// <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>
pub fn get_force(&self) -> &::std::option::Option<bool> {
self.inner.get_force()
}
}