aws_sdk_ecs/operation/list_task_definition_families/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_task_definition_families::_list_task_definition_families_output::ListTaskDefinitionFamiliesOutputBuilder;
3
4pub use crate::operation::list_task_definition_families::_list_task_definition_families_input::ListTaskDefinitionFamiliesInputBuilder;
5
6impl crate::operation::list_task_definition_families::builders::ListTaskDefinitionFamiliesInputBuilder {
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_task_definition_families::ListTaskDefinitionFamiliesOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::list_task_definition_families::ListTaskDefinitionFamiliesError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.list_task_definition_families();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ListTaskDefinitionFamilies`.
24///
25/// <p>Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any <code>ACTIVE</code> task definition revisions.</p>
26/// <p>You can filter out task definition families that don't contain any <code>ACTIVE</code> task definition revisions by setting the <code>status</code> parameter to <code>ACTIVE</code>. You can also filter the results with the <code>familyPrefix</code> parameter.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct ListTaskDefinitionFamiliesFluentBuilder {
29 handle: ::std::sync::Arc<crate::client::Handle>,
30 inner: crate::operation::list_task_definition_families::builders::ListTaskDefinitionFamiliesInputBuilder,
31 config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34 crate::client::customize::internal::CustomizableSend<
35 crate::operation::list_task_definition_families::ListTaskDefinitionFamiliesOutput,
36 crate::operation::list_task_definition_families::ListTaskDefinitionFamiliesError,
37 > for ListTaskDefinitionFamiliesFluentBuilder
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_task_definition_families::ListTaskDefinitionFamiliesOutput,
45 crate::operation::list_task_definition_families::ListTaskDefinitionFamiliesError,
46 >,
47 > {
48 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49 }
50}
51impl ListTaskDefinitionFamiliesFluentBuilder {
52 /// Creates a new `ListTaskDefinitionFamiliesFluentBuilder`.
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 ListTaskDefinitionFamilies as a reference.
61 pub fn as_input(&self) -> &crate::operation::list_task_definition_families::builders::ListTaskDefinitionFamiliesInputBuilder {
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_task_definition_families::ListTaskDefinitionFamiliesOutput,
76 ::aws_smithy_runtime_api::client::result::SdkError<
77 crate::operation::list_task_definition_families::ListTaskDefinitionFamiliesError,
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_task_definition_families::ListTaskDefinitionFamilies::operation_runtime_plugins(
86 self.handle.runtime_plugins.clone(),
87 &self.handle.conf,
88 self.config_override,
89 );
90 crate::operation::list_task_definition_families::ListTaskDefinitionFamilies::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_task_definition_families::ListTaskDefinitionFamiliesOutput,
98 crate::operation::list_task_definition_families::ListTaskDefinitionFamiliesError,
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_task_definition_families::paginator::ListTaskDefinitionFamiliesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115 pub fn into_paginator(self) -> crate::operation::list_task_definition_families::paginator::ListTaskDefinitionFamiliesPaginator {
116 crate::operation::list_task_definition_families::paginator::ListTaskDefinitionFamiliesPaginator::new(self.handle, self.inner)
117 }
118 /// <p>The <code>familyPrefix</code> is a string that's used to filter the results of <code>ListTaskDefinitionFamilies</code>. If you specify a <code>familyPrefix</code>, only task definition family names that begin with the <code>familyPrefix</code> string are returned.</p>
119 pub fn family_prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
120 self.inner = self.inner.family_prefix(input.into());
121 self
122 }
123 /// <p>The <code>familyPrefix</code> is a string that's used to filter the results of <code>ListTaskDefinitionFamilies</code>. If you specify a <code>familyPrefix</code>, only task definition family names that begin with the <code>familyPrefix</code> string are returned.</p>
124 pub fn set_family_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
125 self.inner = self.inner.set_family_prefix(input);
126 self
127 }
128 /// <p>The <code>familyPrefix</code> is a string that's used to filter the results of <code>ListTaskDefinitionFamilies</code>. If you specify a <code>familyPrefix</code>, only task definition family names that begin with the <code>familyPrefix</code> string are returned.</p>
129 pub fn get_family_prefix(&self) -> &::std::option::Option<::std::string::String> {
130 self.inner.get_family_prefix()
131 }
132 /// <p>The task definition family status to filter the <code>ListTaskDefinitionFamilies</code> results with. By default, both <code>ACTIVE</code> and <code>INACTIVE</code> task definition families are listed. If this parameter is set to <code>ACTIVE</code>, only task definition families that have an <code>ACTIVE</code> task definition revision are returned. If this parameter is set to <code>INACTIVE</code>, only task definition families that do not have any <code>ACTIVE</code> task definition revisions are returned. If you paginate the resulting output, be sure to keep the <code>status</code> value constant in each subsequent request.</p>
133 pub fn status(mut self, input: crate::types::TaskDefinitionFamilyStatus) -> Self {
134 self.inner = self.inner.status(input);
135 self
136 }
137 /// <p>The task definition family status to filter the <code>ListTaskDefinitionFamilies</code> results with. By default, both <code>ACTIVE</code> and <code>INACTIVE</code> task definition families are listed. If this parameter is set to <code>ACTIVE</code>, only task definition families that have an <code>ACTIVE</code> task definition revision are returned. If this parameter is set to <code>INACTIVE</code>, only task definition families that do not have any <code>ACTIVE</code> task definition revisions are returned. If you paginate the resulting output, be sure to keep the <code>status</code> value constant in each subsequent request.</p>
138 pub fn set_status(mut self, input: ::std::option::Option<crate::types::TaskDefinitionFamilyStatus>) -> Self {
139 self.inner = self.inner.set_status(input);
140 self
141 }
142 /// <p>The task definition family status to filter the <code>ListTaskDefinitionFamilies</code> results with. By default, both <code>ACTIVE</code> and <code>INACTIVE</code> task definition families are listed. If this parameter is set to <code>ACTIVE</code>, only task definition families that have an <code>ACTIVE</code> task definition revision are returned. If this parameter is set to <code>INACTIVE</code>, only task definition families that do not have any <code>ACTIVE</code> task definition revisions are returned. If you paginate the resulting output, be sure to keep the <code>status</code> value constant in each subsequent request.</p>
143 pub fn get_status(&self) -> &::std::option::Option<crate::types::TaskDefinitionFamilyStatus> {
144 self.inner.get_status()
145 }
146 /// <p>The <code>nextToken</code> value returned from a <code>ListTaskDefinitionFamilies</code> request indicating that more results are available to fulfill the request and further calls will be needed. If <code>maxResults</code> was provided, it is possible the number of results to be fewer than <code>maxResults</code>.</p><note>
147 /// <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>
148 /// </note>
149 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
150 self.inner = self.inner.next_token(input.into());
151 self
152 }
153 /// <p>The <code>nextToken</code> value returned from a <code>ListTaskDefinitionFamilies</code> request indicating that more results are available to fulfill the request and further calls will be needed. If <code>maxResults</code> was provided, it is possible the number of results to be fewer than <code>maxResults</code>.</p><note>
154 /// <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>
155 /// </note>
156 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
157 self.inner = self.inner.set_next_token(input);
158 self
159 }
160 /// <p>The <code>nextToken</code> value returned from a <code>ListTaskDefinitionFamilies</code> request indicating that more results are available to fulfill the request and further calls will be needed. If <code>maxResults</code> was provided, it is possible the number of results to be fewer than <code>maxResults</code>.</p><note>
161 /// <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>
162 /// </note>
163 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
164 self.inner.get_next_token()
165 }
166 /// <p>The maximum number of task definition family results that <code>ListTaskDefinitionFamilies</code> returned in paginated output. When this parameter is used, <code>ListTaskDefinitions</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>ListTaskDefinitionFamilies</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>ListTaskDefinitionFamilies</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
167 pub fn max_results(mut self, input: i32) -> Self {
168 self.inner = self.inner.max_results(input);
169 self
170 }
171 /// <p>The maximum number of task definition family results that <code>ListTaskDefinitionFamilies</code> returned in paginated output. When this parameter is used, <code>ListTaskDefinitions</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>ListTaskDefinitionFamilies</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>ListTaskDefinitionFamilies</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
172 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
173 self.inner = self.inner.set_max_results(input);
174 self
175 }
176 /// <p>The maximum number of task definition family results that <code>ListTaskDefinitionFamilies</code> returned in paginated output. When this parameter is used, <code>ListTaskDefinitions</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>ListTaskDefinitionFamilies</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>ListTaskDefinitionFamilies</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
177 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
178 self.inner.get_max_results()
179 }
180}