aws_sdk_elasticbeanstalk/operation/list_platform_branches/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_platform_branches::_list_platform_branches_output::ListPlatformBranchesOutputBuilder;
3
4pub use crate::operation::list_platform_branches::_list_platform_branches_input::ListPlatformBranchesInputBuilder;
5
6impl crate::operation::list_platform_branches::builders::ListPlatformBranchesInputBuilder {
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_platform_branches::ListPlatformBranchesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_platform_branches::ListPlatformBranchesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_platform_branches();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListPlatformBranches`.
24///
25/// <p>Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.</p>
26/// <p>For definitions of platform branch and other platform-related terms, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html">AWS Elastic Beanstalk Platforms Glossary</a>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct ListPlatformBranchesFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::list_platform_branches::builders::ListPlatformBranchesInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::list_platform_branches::ListPlatformBranchesOutput,
36        crate::operation::list_platform_branches::ListPlatformBranchesError,
37    > for ListPlatformBranchesFluentBuilder
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_platform_branches::ListPlatformBranchesOutput,
45            crate::operation::list_platform_branches::ListPlatformBranchesError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl ListPlatformBranchesFluentBuilder {
52    /// Creates a new `ListPlatformBranchesFluentBuilder`.
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 ListPlatformBranches as a reference.
61    pub fn as_input(&self) -> &crate::operation::list_platform_branches::builders::ListPlatformBranchesInputBuilder {
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_platform_branches::ListPlatformBranchesOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::list_platform_branches::ListPlatformBranchesError,
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_platform_branches::ListPlatformBranches::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::list_platform_branches::ListPlatformBranches::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_platform_branches::ListPlatformBranchesOutput,
98        crate::operation::list_platform_branches::ListPlatformBranchesError,
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_platform_branches::paginator::ListPlatformBranchesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::list_platform_branches::paginator::ListPlatformBranchesPaginator {
116        crate::operation::list_platform_branches::paginator::ListPlatformBranchesPaginator::new(self.handle, self.inner)
117    }
118    ///
119    /// Appends an item to `Filters`.
120    ///
121    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
122    ///
123    /// <p>Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate <code>SearchFilter</code> terms.</p>
124    /// <p>The following list shows valid attribute values for each of the <code>SearchFilter</code> terms. Most operators take a single value. The <code>in</code> and <code>not_in</code> operators can take multiple values.</p>
125    /// <ul>
126    /// <li>
127    /// <p><code>Attribute = BranchName</code>:</p>
128    /// <ul>
129    /// <li>
130    /// <p><code>Operator</code>: <code>=</code> | <code>!=</code> | <code>begins_with</code> | <code>ends_with</code> | <code>contains</code> | <code>in</code> | <code>not_in</code></p></li>
131    /// </ul></li>
132    /// <li>
133    /// <p><code>Attribute = LifecycleState</code>:</p>
134    /// <ul>
135    /// <li>
136    /// <p><code>Operator</code>: <code>=</code> | <code>!=</code> | <code>in</code> | <code>not_in</code></p></li>
137    /// <li>
138    /// <p><code>Values</code>: <code>beta</code> | <code>supported</code> | <code>deprecated</code> | <code>retired</code></p></li>
139    /// </ul></li>
140    /// <li>
141    /// <p><code>Attribute = PlatformName</code>:</p>
142    /// <ul>
143    /// <li>
144    /// <p><code>Operator</code>: <code>=</code> | <code>!=</code> | <code>begins_with</code> | <code>ends_with</code> | <code>contains</code> | <code>in</code> | <code>not_in</code></p></li>
145    /// </ul></li>
146    /// <li>
147    /// <p><code>Attribute = TierType</code>:</p>
148    /// <ul>
149    /// <li>
150    /// <p><code>Operator</code>: <code>=</code> | <code>!=</code></p></li>
151    /// <li>
152    /// <p><code>Values</code>: <code>WebServer/Standard</code> | <code>Worker/SQS/HTTP</code></p></li>
153    /// </ul></li>
154    /// </ul>
155    /// <p>Array size: limited to 10 <code>SearchFilter</code> objects.</p>
156    /// <p>Within each <code>SearchFilter</code> item, the <code>Values</code> array is limited to 10 items.</p>
157    pub fn filters(mut self, input: crate::types::SearchFilter) -> Self {
158        self.inner = self.inner.filters(input);
159        self
160    }
161    /// <p>Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate <code>SearchFilter</code> terms.</p>
162    /// <p>The following list shows valid attribute values for each of the <code>SearchFilter</code> terms. Most operators take a single value. The <code>in</code> and <code>not_in</code> operators can take multiple values.</p>
163    /// <ul>
164    /// <li>
165    /// <p><code>Attribute = BranchName</code>:</p>
166    /// <ul>
167    /// <li>
168    /// <p><code>Operator</code>: <code>=</code> | <code>!=</code> | <code>begins_with</code> | <code>ends_with</code> | <code>contains</code> | <code>in</code> | <code>not_in</code></p></li>
169    /// </ul></li>
170    /// <li>
171    /// <p><code>Attribute = LifecycleState</code>:</p>
172    /// <ul>
173    /// <li>
174    /// <p><code>Operator</code>: <code>=</code> | <code>!=</code> | <code>in</code> | <code>not_in</code></p></li>
175    /// <li>
176    /// <p><code>Values</code>: <code>beta</code> | <code>supported</code> | <code>deprecated</code> | <code>retired</code></p></li>
177    /// </ul></li>
178    /// <li>
179    /// <p><code>Attribute = PlatformName</code>:</p>
180    /// <ul>
181    /// <li>
182    /// <p><code>Operator</code>: <code>=</code> | <code>!=</code> | <code>begins_with</code> | <code>ends_with</code> | <code>contains</code> | <code>in</code> | <code>not_in</code></p></li>
183    /// </ul></li>
184    /// <li>
185    /// <p><code>Attribute = TierType</code>:</p>
186    /// <ul>
187    /// <li>
188    /// <p><code>Operator</code>: <code>=</code> | <code>!=</code></p></li>
189    /// <li>
190    /// <p><code>Values</code>: <code>WebServer/Standard</code> | <code>Worker/SQS/HTTP</code></p></li>
191    /// </ul></li>
192    /// </ul>
193    /// <p>Array size: limited to 10 <code>SearchFilter</code> objects.</p>
194    /// <p>Within each <code>SearchFilter</code> item, the <code>Values</code> array is limited to 10 items.</p>
195    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::SearchFilter>>) -> Self {
196        self.inner = self.inner.set_filters(input);
197        self
198    }
199    /// <p>Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate <code>SearchFilter</code> terms.</p>
200    /// <p>The following list shows valid attribute values for each of the <code>SearchFilter</code> terms. Most operators take a single value. The <code>in</code> and <code>not_in</code> operators can take multiple values.</p>
201    /// <ul>
202    /// <li>
203    /// <p><code>Attribute = BranchName</code>:</p>
204    /// <ul>
205    /// <li>
206    /// <p><code>Operator</code>: <code>=</code> | <code>!=</code> | <code>begins_with</code> | <code>ends_with</code> | <code>contains</code> | <code>in</code> | <code>not_in</code></p></li>
207    /// </ul></li>
208    /// <li>
209    /// <p><code>Attribute = LifecycleState</code>:</p>
210    /// <ul>
211    /// <li>
212    /// <p><code>Operator</code>: <code>=</code> | <code>!=</code> | <code>in</code> | <code>not_in</code></p></li>
213    /// <li>
214    /// <p><code>Values</code>: <code>beta</code> | <code>supported</code> | <code>deprecated</code> | <code>retired</code></p></li>
215    /// </ul></li>
216    /// <li>
217    /// <p><code>Attribute = PlatformName</code>:</p>
218    /// <ul>
219    /// <li>
220    /// <p><code>Operator</code>: <code>=</code> | <code>!=</code> | <code>begins_with</code> | <code>ends_with</code> | <code>contains</code> | <code>in</code> | <code>not_in</code></p></li>
221    /// </ul></li>
222    /// <li>
223    /// <p><code>Attribute = TierType</code>:</p>
224    /// <ul>
225    /// <li>
226    /// <p><code>Operator</code>: <code>=</code> | <code>!=</code></p></li>
227    /// <li>
228    /// <p><code>Values</code>: <code>WebServer/Standard</code> | <code>Worker/SQS/HTTP</code></p></li>
229    /// </ul></li>
230    /// </ul>
231    /// <p>Array size: limited to 10 <code>SearchFilter</code> objects.</p>
232    /// <p>Within each <code>SearchFilter</code> item, the <code>Values</code> array is limited to 10 items.</p>
233    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::SearchFilter>> {
234        self.inner.get_filters()
235    }
236    /// <p>The maximum number of platform branch values returned in one call.</p>
237    pub fn max_records(mut self, input: i32) -> Self {
238        self.inner = self.inner.max_records(input);
239        self
240    }
241    /// <p>The maximum number of platform branch values returned in one call.</p>
242    pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
243        self.inner = self.inner.set_max_records(input);
244        self
245    }
246    /// <p>The maximum number of platform branch values returned in one call.</p>
247    pub fn get_max_records(&self) -> &::std::option::Option<i32> {
248        self.inner.get_max_records()
249    }
250    /// <p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.</p>
251    /// <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>
252    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
253        self.inner = self.inner.next_token(input.into());
254        self
255    }
256    /// <p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.</p>
257    /// <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>
258    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
259        self.inner = self.inner.set_next_token(input);
260        self
261    }
262    /// <p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.</p>
263    /// <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>
264    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
265        self.inner.get_next_token()
266    }
267}