aws_sdk_sqs/operation/purge_queue/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::purge_queue::_purge_queue_output::PurgeQueueOutputBuilder;
3
4pub use crate::operation::purge_queue::_purge_queue_input::PurgeQueueInputBuilder;
5
6impl crate::operation::purge_queue::builders::PurgeQueueInputBuilder {
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::purge_queue::PurgeQueueOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::purge_queue::PurgeQueueError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.purge_queue();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `PurgeQueue`.
24///
25/// <p>Deletes available messages in a queue (including in-flight messages) specified by the <code>QueueURL</code> parameter.</p><important>
26/// <p>When you use the <code>PurgeQueue</code> action, you can't retrieve any messages deleted from a queue.</p>
27/// <p>The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size.</p>
28/// </important>
29/// <p>Messages sent to the queue <i>before</i> you call <code>PurgeQueue</code> might be received but are deleted within the next minute.</p>
30/// <p>Messages sent to the queue <i>after</i> you call <code>PurgeQueue</code> might be deleted while the queue is being purged.</p>
31#[derive(::std::clone::Clone, ::std::fmt::Debug)]
32pub struct PurgeQueueFluentBuilder {
33    handle: ::std::sync::Arc<crate::client::Handle>,
34    inner: crate::operation::purge_queue::builders::PurgeQueueInputBuilder,
35    config_override: ::std::option::Option<crate::config::Builder>,
36}
37impl
38    crate::client::customize::internal::CustomizableSend<
39        crate::operation::purge_queue::PurgeQueueOutput,
40        crate::operation::purge_queue::PurgeQueueError,
41    > for PurgeQueueFluentBuilder
42{
43    fn send(
44        self,
45        config_override: crate::config::Builder,
46    ) -> crate::client::customize::internal::BoxFuture<
47        crate::client::customize::internal::SendResult<
48            crate::operation::purge_queue::PurgeQueueOutput,
49            crate::operation::purge_queue::PurgeQueueError,
50        >,
51    > {
52        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
53    }
54}
55impl PurgeQueueFluentBuilder {
56    /// Creates a new `PurgeQueueFluentBuilder`.
57    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
58        Self {
59            handle,
60            inner: ::std::default::Default::default(),
61            config_override: ::std::option::Option::None,
62        }
63    }
64    /// Access the PurgeQueue as a reference.
65    pub fn as_input(&self) -> &crate::operation::purge_queue::builders::PurgeQueueInputBuilder {
66        &self.inner
67    }
68    /// Sends the request and returns the response.
69    ///
70    /// If an error occurs, an `SdkError` will be returned with additional details that
71    /// can be matched against.
72    ///
73    /// By default, any retryable failures will be retried twice. Retry behavior
74    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
75    /// set when configuring the client.
76    pub async fn send(
77        self,
78    ) -> ::std::result::Result<
79        crate::operation::purge_queue::PurgeQueueOutput,
80        ::aws_smithy_runtime_api::client::result::SdkError<
81            crate::operation::purge_queue::PurgeQueueError,
82            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
83        >,
84    > {
85        let input = self
86            .inner
87            .build()
88            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
89        let runtime_plugins = crate::operation::purge_queue::PurgeQueue::operation_runtime_plugins(
90            self.handle.runtime_plugins.clone(),
91            &self.handle.conf,
92            self.config_override,
93        );
94        crate::operation::purge_queue::PurgeQueue::orchestrate(&runtime_plugins, input).await
95    }
96
97    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
98    pub fn customize(
99        self,
100    ) -> crate::client::customize::CustomizableOperation<
101        crate::operation::purge_queue::PurgeQueueOutput,
102        crate::operation::purge_queue::PurgeQueueError,
103        Self,
104    > {
105        crate::client::customize::CustomizableOperation::new(self)
106    }
107    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
108        self.set_config_override(::std::option::Option::Some(config_override.into()));
109        self
110    }
111
112    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
113        self.config_override = config_override;
114        self
115    }
116    /// <p>The URL of the queue from which the <code>PurgeQueue</code> action deletes messages.</p>
117    /// <p>Queue URLs and names are case-sensitive.</p>
118    pub fn queue_url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
119        self.inner = self.inner.queue_url(input.into());
120        self
121    }
122    /// <p>The URL of the queue from which the <code>PurgeQueue</code> action deletes messages.</p>
123    /// <p>Queue URLs and names are case-sensitive.</p>
124    pub fn set_queue_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
125        self.inner = self.inner.set_queue_url(input);
126        self
127    }
128    /// <p>The URL of the queue from which the <code>PurgeQueue</code> action deletes messages.</p>
129    /// <p>Queue URLs and names are case-sensitive.</p>
130    pub fn get_queue_url(&self) -> &::std::option::Option<::std::string::String> {
131        self.inner.get_queue_url()
132    }
133}
aws_sdk_sqs/operation/purge_queue/builders.rs

aws_sdk_sqs/operation/purge_queue/
builders.rs
