aws_sdk_ecs/operation/list_attributes/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_attributes::_list_attributes_output::ListAttributesOutputBuilder;
3
4pub use crate::operation::list_attributes::_list_attributes_input::ListAttributesInputBuilder;
5
6impl crate::operation::list_attributes::builders::ListAttributesInputBuilder {
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_attributes::ListAttributesOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::list_attributes::ListAttributesError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.list_attributes();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ListAttributes`.
24///
25/// <p>Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, <code>ListAttributes</code> returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value. You can do this, for example, to see which container instances in a cluster are running a Linux AMI (<code>ecs.os-type=linux</code>).</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct ListAttributesFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::list_attributes::builders::ListAttributesInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::list_attributes::ListAttributesOutput,
35 crate::operation::list_attributes::ListAttributesError,
36 > for ListAttributesFluentBuilder
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_attributes::ListAttributesOutput,
44 crate::operation::list_attributes::ListAttributesError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl ListAttributesFluentBuilder {
51 /// Creates a new `ListAttributesFluentBuilder`.
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 ListAttributes as a reference.
60 pub fn as_input(&self) -> &crate::operation::list_attributes::builders::ListAttributesInputBuilder {
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_attributes::ListAttributesOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::list_attributes::ListAttributesError,
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_attributes::ListAttributes::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::list_attributes::ListAttributes::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_attributes::ListAttributesOutput,
97 crate::operation::list_attributes::ListAttributesError,
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_attributes::paginator::ListAttributesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114 pub fn into_paginator(self) -> crate::operation::list_attributes::paginator::ListAttributesPaginator {
115 crate::operation::list_attributes::paginator::ListAttributesPaginator::new(self.handle, self.inner)
116 }
117 /// <p>The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.</p>
118 pub fn cluster(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
119 self.inner = self.inner.cluster(input.into());
120 self
121 }
122 /// <p>The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.</p>
123 pub fn set_cluster(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
124 self.inner = self.inner.set_cluster(input);
125 self
126 }
127 /// <p>The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.</p>
128 pub fn get_cluster(&self) -> &::std::option::Option<::std::string::String> {
129 self.inner.get_cluster()
130 }
131 /// <p>The type of the target to list attributes with.</p>
132 pub fn target_type(mut self, input: crate::types::TargetType) -> Self {
133 self.inner = self.inner.target_type(input);
134 self
135 }
136 /// <p>The type of the target to list attributes with.</p>
137 pub fn set_target_type(mut self, input: ::std::option::Option<crate::types::TargetType>) -> Self {
138 self.inner = self.inner.set_target_type(input);
139 self
140 }
141 /// <p>The type of the target to list attributes with.</p>
142 pub fn get_target_type(&self) -> &::std::option::Option<crate::types::TargetType> {
143 self.inner.get_target_type()
144 }
145 /// <p>The name of the attribute to filter the results with.</p>
146 pub fn attribute_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
147 self.inner = self.inner.attribute_name(input.into());
148 self
149 }
150 /// <p>The name of the attribute to filter the results with.</p>
151 pub fn set_attribute_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
152 self.inner = self.inner.set_attribute_name(input);
153 self
154 }
155 /// <p>The name of the attribute to filter the results with.</p>
156 pub fn get_attribute_name(&self) -> &::std::option::Option<::std::string::String> {
157 self.inner.get_attribute_name()
158 }
159 /// <p>The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.</p>
160 pub fn attribute_value(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
161 self.inner = self.inner.attribute_value(input.into());
162 self
163 }
164 /// <p>The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.</p>
165 pub fn set_attribute_value(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
166 self.inner = self.inner.set_attribute_value(input);
167 self
168 }
169 /// <p>The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.</p>
170 pub fn get_attribute_value(&self) -> &::std::option::Option<::std::string::String> {
171 self.inner.get_attribute_value()
172 }
173 /// <p>The <code>nextToken</code> value returned from a <code>ListAttributes</code> request indicating that more results are available to fulfill the request and further calls are needed. If <code>maxResults</code> was provided, it's possible the number of results to be fewer than <code>maxResults</code>.</p><note>
174 /// <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>
175 /// </note>
176 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
177 self.inner = self.inner.next_token(input.into());
178 self
179 }
180 /// <p>The <code>nextToken</code> value returned from a <code>ListAttributes</code> request indicating that more results are available to fulfill the request and further calls are needed. If <code>maxResults</code> was provided, it's possible the number of results to be fewer than <code>maxResults</code>.</p><note>
181 /// <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>
182 /// </note>
183 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
184 self.inner = self.inner.set_next_token(input);
185 self
186 }
187 /// <p>The <code>nextToken</code> value returned from a <code>ListAttributes</code> request indicating that more results are available to fulfill the request and further calls are needed. If <code>maxResults</code> was provided, it's possible the number of results to be fewer than <code>maxResults</code>.</p><note>
188 /// <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>
189 /// </note>
190 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
191 self.inner.get_next_token()
192 }
193 /// <p>The maximum number of cluster results that <code>ListAttributes</code> returned in paginated output. When this parameter is used, <code>ListAttributes</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>ListAttributes</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>ListAttributes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
194 pub fn max_results(mut self, input: i32) -> Self {
195 self.inner = self.inner.max_results(input);
196 self
197 }
198 /// <p>The maximum number of cluster results that <code>ListAttributes</code> returned in paginated output. When this parameter is used, <code>ListAttributes</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>ListAttributes</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>ListAttributes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
199 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
200 self.inner = self.inner.set_max_results(input);
201 self
202 }
203 /// <p>The maximum number of cluster results that <code>ListAttributes</code> returned in paginated output. When this parameter is used, <code>ListAttributes</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>ListAttributes</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>ListAttributes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
204 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
205 self.inner.get_max_results()
206 }
207}