aws_sdk_docdb/operation/describe_db_clusters/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_db_clusters::_describe_db_clusters_output::DescribeDbClustersOutputBuilder;
3
4pub use crate::operation::describe_db_clusters::_describe_db_clusters_input::DescribeDbClustersInputBuilder;
5
6impl crate::operation::describe_db_clusters::builders::DescribeDbClustersInputBuilder {
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_db_clusters::DescribeDbClustersOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::describe_db_clusters::DescribeDBClustersError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.describe_db_clusters();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DescribeDBClusters`.
24///
25/// <p>Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the <code>filterName=engine,Values=docdb</code> filter parameter to return only Amazon DocumentDB clusters.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DescribeDBClustersFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::describe_db_clusters::builders::DescribeDbClustersInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::describe_db_clusters::DescribeDbClustersOutput,
35 crate::operation::describe_db_clusters::DescribeDBClustersError,
36 > for DescribeDBClustersFluentBuilder
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_db_clusters::DescribeDbClustersOutput,
44 crate::operation::describe_db_clusters::DescribeDBClustersError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl DescribeDBClustersFluentBuilder {
51 /// Creates a new `DescribeDBClustersFluentBuilder`.
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 DescribeDBClusters as a reference.
60 pub fn as_input(&self) -> &crate::operation::describe_db_clusters::builders::DescribeDbClustersInputBuilder {
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_db_clusters::DescribeDbClustersOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::describe_db_clusters::DescribeDBClustersError,
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_db_clusters::DescribeDBClusters::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::describe_db_clusters::DescribeDBClusters::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_db_clusters::DescribeDbClustersOutput,
97 crate::operation::describe_db_clusters::DescribeDBClustersError,
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::describe_db_clusters::paginator::DescribeDbClustersPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114 pub fn into_paginator(self) -> crate::operation::describe_db_clusters::paginator::DescribeDbClustersPaginator {
115 crate::operation::describe_db_clusters::paginator::DescribeDbClustersPaginator::new(self.handle, self.inner)
116 }
117 /// <p>The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.</p>
118 /// <p>Constraints:</p>
119 /// <ul>
120 /// <li>
121 /// <p>If provided, must match an existing <code>DBClusterIdentifier</code>.</p></li>
122 /// </ul>
123 pub fn db_cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
124 self.inner = self.inner.db_cluster_identifier(input.into());
125 self
126 }
127 /// <p>The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.</p>
128 /// <p>Constraints:</p>
129 /// <ul>
130 /// <li>
131 /// <p>If provided, must match an existing <code>DBClusterIdentifier</code>.</p></li>
132 /// </ul>
133 pub fn set_db_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134 self.inner = self.inner.set_db_cluster_identifier(input);
135 self
136 }
137 /// <p>The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.</p>
138 /// <p>Constraints:</p>
139 /// <ul>
140 /// <li>
141 /// <p>If provided, must match an existing <code>DBClusterIdentifier</code>.</p></li>
142 /// </ul>
143 pub fn get_db_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
144 self.inner.get_db_cluster_identifier()
145 }
146 ///
147 /// Appends an item to `Filters`.
148 ///
149 /// To override the contents of this collection use [`set_filters`](Self::set_filters).
150 ///
151 /// <p>A filter that specifies one or more clusters to describe.</p>
152 /// <p>Supported filters:</p>
153 /// <ul>
154 /// <li>
155 /// <p><code>db-cluster-id</code> - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.</p></li>
156 /// </ul>
157 pub fn filters(mut self, input: crate::types::Filter) -> Self {
158 self.inner = self.inner.filters(input);
159 self
160 }
161 /// <p>A filter that specifies one or more clusters to describe.</p>
162 /// <p>Supported filters:</p>
163 /// <ul>
164 /// <li>
165 /// <p><code>db-cluster-id</code> - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.</p></li>
166 /// </ul>
167 pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
168 self.inner = self.inner.set_filters(input);
169 self
170 }
171 /// <p>A filter that specifies one or more clusters to describe.</p>
172 /// <p>Supported filters:</p>
173 /// <ul>
174 /// <li>
175 /// <p><code>db-cluster-id</code> - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.</p></li>
176 /// </ul>
177 pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
178 self.inner.get_filters()
179 }
180 /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p>
181 /// <p>Default: 100</p>
182 /// <p>Constraints: Minimum 20, maximum 100.</p>
183 pub fn max_records(mut self, input: i32) -> Self {
184 self.inner = self.inner.max_records(input);
185 self
186 }
187 /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p>
188 /// <p>Default: 100</p>
189 /// <p>Constraints: Minimum 20, maximum 100.</p>
190 pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
191 self.inner = self.inner.set_max_records(input);
192 self
193 }
194 /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p>
195 /// <p>Default: 100</p>
196 /// <p>Constraints: Minimum 20, maximum 100.</p>
197 pub fn get_max_records(&self) -> &::std::option::Option<i32> {
198 self.inner.get_max_records()
199 }
200 /// <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
201 pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
202 self.inner = self.inner.marker(input.into());
203 self
204 }
205 /// <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
206 pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
207 self.inner = self.inner.set_marker(input);
208 self
209 }
210 /// <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
211 pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
212 self.inner.get_marker()
213 }
214}