aws_sdk_iotdataplane/operation/list_subscriptions/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_subscriptions::_list_subscriptions_input::ListSubscriptionsInputBuilder;
3
4pub use crate::operation::list_subscriptions::_list_subscriptions_output::ListSubscriptionsOutputBuilder;
5
6impl crate::operation::list_subscriptions::builders::ListSubscriptionsInputBuilder {
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::list_subscriptions::ListSubscriptionsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_subscriptions::ListSubscriptionsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_subscriptions();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListSubscriptions`.
24///
25/// <p>Returns a list of all subscriptions for MQTT clients with active sessions, including offline clients with persistent sessions.</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">ListSubscriptions</a> action.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct ListSubscriptionsFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::list_subscriptions::builders::ListSubscriptionsInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::list_subscriptions::ListSubscriptionsOutput,
36        crate::operation::list_subscriptions::ListSubscriptionsError,
37    > for ListSubscriptionsFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::list_subscriptions::ListSubscriptionsOutput,
45            crate::operation::list_subscriptions::ListSubscriptionsError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl ListSubscriptionsFluentBuilder {
52    /// Creates a new `ListSubscriptionsFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the ListSubscriptions as a reference.
61    pub fn as_input(&self) -> &crate::operation::list_subscriptions::builders::ListSubscriptionsInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::list_subscriptions::ListSubscriptionsOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::list_subscriptions::ListSubscriptionsError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::list_subscriptions::ListSubscriptions::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::list_subscriptions::ListSubscriptions::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::list_subscriptions::ListSubscriptionsOutput,
98        crate::operation::list_subscriptions::ListSubscriptionsError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// Create a paginator for this request
113    ///
114    /// Paginators are used by calling [`send().await`](crate::operation::list_subscriptions::paginator::ListSubscriptionsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::list_subscriptions::paginator::ListSubscriptionsPaginator {
116        crate::operation::list_subscriptions::paginator::ListSubscriptionsPaginator::new(self.handle, self.inner)
117    }
118    /// <p>The unique identifier of the MQTT client to list subscriptions for. The client ID can't start with a dollar sign ($).</p>
119    /// <p>MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.</p>
120    pub fn client_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
121        self.inner = self.inner.client_id(input.into());
122        self
123    }
124    /// <p>The unique identifier of the MQTT client to list subscriptions for. The client ID can't start with a dollar sign ($).</p>
125    /// <p>MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.</p>
126    pub fn set_client_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
127        self.inner = self.inner.set_client_id(input);
128        self
129    }
130    /// <p>The unique identifier of the MQTT client to list subscriptions for. The client ID can't start with a dollar sign ($).</p>
131    /// <p>MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.</p>
132    pub fn get_client_id(&self) -> &::std::option::Option<::std::string::String> {
133        self.inner.get_client_id()
134    }
135    /// <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>
136    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
137        self.inner = self.inner.next_token(input.into());
138        self
139    }
140    /// <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>
141    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
142        self.inner = self.inner.set_next_token(input);
143        self
144    }
145    /// <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>
146    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
147        self.inner.get_next_token()
148    }
149    /// <p>The maximum number of subscriptions to return in a single request. By default, this is set to 20.</p>
150    pub fn max_results(mut self, input: i32) -> Self {
151        self.inner = self.inner.max_results(input);
152        self
153    }
154    /// <p>The maximum number of subscriptions to return in a single request. By default, this is set to 20.</p>
155    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
156        self.inner = self.inner.set_max_results(input);
157        self
158    }
159    /// <p>The maximum number of subscriptions to return in a single request. By default, this is set to 20.</p>
160    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
161        self.inner.get_max_results()
162    }
163}
aws_sdk_iotdataplane/operation/list_subscriptions/builders.rs

aws_sdk_iotdataplane/operation/list_subscriptions/
builders.rs
