aws_sdk_ecs/operation/describe_capacity_providers/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_capacity_providers::_describe_capacity_providers_output::DescribeCapacityProvidersOutputBuilder;
3
4pub use crate::operation::describe_capacity_providers::_describe_capacity_providers_input::DescribeCapacityProvidersInputBuilder;
5
6impl crate::operation::describe_capacity_providers::builders::DescribeCapacityProvidersInputBuilder {
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::describe_capacity_providers::DescribeCapacityProvidersOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_capacity_providers::DescribeCapacityProvidersError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_capacity_providers();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeCapacityProviders`.
24///
25/// <p>Describes one or more of your capacity providers.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DescribeCapacityProvidersFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::describe_capacity_providers::builders::DescribeCapacityProvidersInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::describe_capacity_providers::DescribeCapacityProvidersOutput,
35        crate::operation::describe_capacity_providers::DescribeCapacityProvidersError,
36    > for DescribeCapacityProvidersFluentBuilder
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::describe_capacity_providers::DescribeCapacityProvidersOutput,
44            crate::operation::describe_capacity_providers::DescribeCapacityProvidersError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl DescribeCapacityProvidersFluentBuilder {
51    /// Creates a new `DescribeCapacityProvidersFluentBuilder`.
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 DescribeCapacityProviders as a reference.
60    pub fn as_input(&self) -> &crate::operation::describe_capacity_providers::builders::DescribeCapacityProvidersInputBuilder {
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::describe_capacity_providers::DescribeCapacityProvidersOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::describe_capacity_providers::DescribeCapacityProvidersError,
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::describe_capacity_providers::DescribeCapacityProviders::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::describe_capacity_providers::DescribeCapacityProviders::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::describe_capacity_providers::DescribeCapacityProvidersOutput,
97        crate::operation::describe_capacity_providers::DescribeCapacityProvidersError,
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    ///
112    /// Appends an item to `capacityProviders`.
113    ///
114    /// To override the contents of this collection use [`set_capacity_providers`](Self::set_capacity_providers).
115    ///
116    /// <p>The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to <code>100</code> capacity providers can be described in an action.</p>
117    pub fn capacity_providers(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
118        self.inner = self.inner.capacity_providers(input.into());
119        self
120    }
121    /// <p>The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to <code>100</code> capacity providers can be described in an action.</p>
122    pub fn set_capacity_providers(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
123        self.inner = self.inner.set_capacity_providers(input);
124        self
125    }
126    /// <p>The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to <code>100</code> capacity providers can be described in an action.</p>
127    pub fn get_capacity_providers(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
128        self.inner.get_capacity_providers()
129    }
130    /// <p>The name of the cluster to describe capacity providers for. When specified, only capacity providers associated with this cluster are returned, including Amazon ECS Managed Instances capacity providers.</p>
131    pub fn cluster(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
132        self.inner = self.inner.cluster(input.into());
133        self
134    }
135    /// <p>The name of the cluster to describe capacity providers for. When specified, only capacity providers associated with this cluster are returned, including Amazon ECS Managed Instances capacity providers.</p>
136    pub fn set_cluster(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
137        self.inner = self.inner.set_cluster(input);
138        self
139    }
140    /// <p>The name of the cluster to describe capacity providers for. When specified, only capacity providers associated with this cluster are returned, including Amazon ECS Managed Instances capacity providers.</p>
141    pub fn get_cluster(&self) -> &::std::option::Option<::std::string::String> {
142        self.inner.get_cluster()
143    }
144    ///
145    /// Appends an item to `include`.
146    ///
147    /// To override the contents of this collection use [`set_include`](Self::set_include).
148    ///
149    /// <p>Specifies whether or not you want to see the resource tags for the capacity provider. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.</p>
150    pub fn include(mut self, input: crate::types::CapacityProviderField) -> Self {
151        self.inner = self.inner.include(input);
152        self
153    }
154    /// <p>Specifies whether or not you want to see the resource tags for the capacity provider. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.</p>
155    pub fn set_include(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::CapacityProviderField>>) -> Self {
156        self.inner = self.inner.set_include(input);
157        self
158    }
159    /// <p>Specifies whether or not you want to see the resource tags for the capacity provider. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.</p>
160    pub fn get_include(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::CapacityProviderField>> {
161        self.inner.get_include()
162    }
163    /// <p>The maximum number of account setting results returned by <code>DescribeCapacityProviders</code> in paginated output. When this parameter is used, <code>DescribeCapacityProviders</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeCapacityProviders</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 10. If this parameter is not used, then <code>DescribeCapacityProviders</code> returns up to 10 results and a <code>nextToken</code> value if applicable.</p>
164    pub fn max_results(mut self, input: i32) -> Self {
165        self.inner = self.inner.max_results(input);
166        self
167    }
168    /// <p>The maximum number of account setting results returned by <code>DescribeCapacityProviders</code> in paginated output. When this parameter is used, <code>DescribeCapacityProviders</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeCapacityProviders</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 10. If this parameter is not used, then <code>DescribeCapacityProviders</code> returns up to 10 results and a <code>nextToken</code> value if applicable.</p>
169    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
170        self.inner = self.inner.set_max_results(input);
171        self
172    }
173    /// <p>The maximum number of account setting results returned by <code>DescribeCapacityProviders</code> in paginated output. When this parameter is used, <code>DescribeCapacityProviders</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeCapacityProviders</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 10. If this parameter is not used, then <code>DescribeCapacityProviders</code> returns up to 10 results and a <code>nextToken</code> value if applicable.</p>
174    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
175        self.inner.get_max_results()
176    }
177    /// <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeCapacityProviders</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p><note>
178    /// <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p>
179    /// </note>
180    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
181        self.inner = self.inner.next_token(input.into());
182        self
183    }
184    /// <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeCapacityProviders</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p><note>
185    /// <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p>
186    /// </note>
187    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
188        self.inner = self.inner.set_next_token(input);
189        self
190    }
191    /// <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeCapacityProviders</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p><note>
192    /// <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p>
193    /// </note>
194    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
195        self.inner.get_next_token()
196    }
197}