aws_sdk_iot/operation/list_commands/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_commands::_list_commands_output::ListCommandsOutputBuilder;
3
4pub use crate::operation::list_commands::_list_commands_input::ListCommandsInputBuilder;
5
6impl crate::operation::list_commands::builders::ListCommandsInputBuilder {
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_commands::ListCommandsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_commands::ListCommandsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_commands();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListCommands`.
24///
25/// <p>List all commands in your account.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct ListCommandsFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::list_commands::builders::ListCommandsInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::list_commands::ListCommandsOutput,
35        crate::operation::list_commands::ListCommandsError,
36    > for ListCommandsFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::list_commands::ListCommandsOutput,
44            crate::operation::list_commands::ListCommandsError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl ListCommandsFluentBuilder {
51    /// Creates a new `ListCommandsFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the ListCommands as a reference.
60    pub fn as_input(&self) -> &crate::operation::list_commands::builders::ListCommandsInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::list_commands::ListCommandsOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::list_commands::ListCommandsError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::list_commands::ListCommands::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::list_commands::ListCommands::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::list_commands::ListCommandsOutput,
97        crate::operation::list_commands::ListCommandsError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// Create a paginator for this request
112    ///
113    /// Paginators are used by calling [`send().await`](crate::operation::list_commands::paginator::ListCommandsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::list_commands::paginator::ListCommandsPaginator {
115        crate::operation::list_commands::paginator::ListCommandsPaginator::new(self.handle, self.inner)
116    }
117    /// <p>The maximum number of results to return in this operation. By default, the API returns up to a maximum of 25 results. You can override this default value to return up to a maximum of 100 results for this operation.</p>
118    pub fn max_results(mut self, input: i32) -> Self {
119        self.inner = self.inner.max_results(input);
120        self
121    }
122    /// <p>The maximum number of results to return in this operation. By default, the API returns up to a maximum of 25 results. You can override this default value to return up to a maximum of 100 results for this operation.</p>
123    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
124        self.inner = self.inner.set_max_results(input);
125        self
126    }
127    /// <p>The maximum number of results to return in this operation. By default, the API returns up to a maximum of 25 results. You can override this default value to return up to a maximum of 100 results for this operation.</p>
128    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
129        self.inner.get_max_results()
130    }
131    /// <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <code>null</code> to receive the first set of results.</p>
132    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133        self.inner = self.inner.next_token(input.into());
134        self
135    }
136    /// <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <code>null</code> to receive the first set of results.</p>
137    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
138        self.inner = self.inner.set_next_token(input);
139        self
140    }
141    /// <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <code>null</code> to receive the first set of results.</p>
142    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
143        self.inner.get_next_token()
144    }
145    /// <p>The namespace of the command. By default, the API returns all commands that have been created for both <code>AWS-IoT</code> and <code>AWS-IoT-FleetWise</code> namespaces. You can override this default value if you want to return all commands that have been created only for a specific namespace.</p>
146    pub fn namespace(mut self, input: crate::types::CommandNamespace) -> Self {
147        self.inner = self.inner.namespace(input);
148        self
149    }
150    /// <p>The namespace of the command. By default, the API returns all commands that have been created for both <code>AWS-IoT</code> and <code>AWS-IoT-FleetWise</code> namespaces. You can override this default value if you want to return all commands that have been created only for a specific namespace.</p>
151    pub fn set_namespace(mut self, input: ::std::option::Option<crate::types::CommandNamespace>) -> Self {
152        self.inner = self.inner.set_namespace(input);
153        self
154    }
155    /// <p>The namespace of the command. By default, the API returns all commands that have been created for both <code>AWS-IoT</code> and <code>AWS-IoT-FleetWise</code> namespaces. You can override this default value if you want to return all commands that have been created only for a specific namespace.</p>
156    pub fn get_namespace(&self) -> &::std::option::Option<crate::types::CommandNamespace> {
157        self.inner.get_namespace()
158    }
159    /// <p>A filter that can be used to display the list of commands that have a specific command parameter name.</p>
160    pub fn command_parameter_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
161        self.inner = self.inner.command_parameter_name(input.into());
162        self
163    }
164    /// <p>A filter that can be used to display the list of commands that have a specific command parameter name.</p>
165    pub fn set_command_parameter_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
166        self.inner = self.inner.set_command_parameter_name(input);
167        self
168    }
169    /// <p>A filter that can be used to display the list of commands that have a specific command parameter name.</p>
170    pub fn get_command_parameter_name(&self) -> &::std::option::Option<::std::string::String> {
171        self.inner.get_command_parameter_name()
172    }
173    /// <p>Specify whether to list the commands that you have created in the ascending or descending order. By default, the API returns all commands in the descending order based on the time that they were created.</p>
174    pub fn sort_order(mut self, input: crate::types::SortOrder) -> Self {
175        self.inner = self.inner.sort_order(input);
176        self
177    }
178    /// <p>Specify whether to list the commands that you have created in the ascending or descending order. By default, the API returns all commands in the descending order based on the time that they were created.</p>
179    pub fn set_sort_order(mut self, input: ::std::option::Option<crate::types::SortOrder>) -> Self {
180        self.inner = self.inner.set_sort_order(input);
181        self
182    }
183    /// <p>Specify whether to list the commands that you have created in the ascending or descending order. By default, the API returns all commands in the descending order based on the time that they were created.</p>
184    pub fn get_sort_order(&self) -> &::std::option::Option<crate::types::SortOrder> {
185        self.inner.get_sort_order()
186    }
187}