aws_sdk_docdb/operation/describe_global_clusters/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_global_clusters::_describe_global_clusters_output::DescribeGlobalClustersOutputBuilder;
3
4pub use crate::operation::describe_global_clusters::_describe_global_clusters_input::DescribeGlobalClustersInputBuilder;
5
6impl crate::operation::describe_global_clusters::builders::DescribeGlobalClustersInputBuilder {
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_global_clusters::DescribeGlobalClustersOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_global_clusters::DescribeGlobalClustersError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_global_clusters();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeGlobalClusters`.
24///
25/// <p>Returns information about Amazon DocumentDB global clusters. This API supports pagination.</p><note>
26/// <p>This action only applies to Amazon DocumentDB clusters.</p>
27/// </note>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct DescribeGlobalClustersFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::describe_global_clusters::builders::DescribeGlobalClustersInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::describe_global_clusters::DescribeGlobalClustersOutput,
37        crate::operation::describe_global_clusters::DescribeGlobalClustersError,
38    > for DescribeGlobalClustersFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::describe_global_clusters::DescribeGlobalClustersOutput,
46            crate::operation::describe_global_clusters::DescribeGlobalClustersError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl DescribeGlobalClustersFluentBuilder {
53    /// Creates a new `DescribeGlobalClustersFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the DescribeGlobalClusters as a reference.
62    pub fn as_input(&self) -> &crate::operation::describe_global_clusters::builders::DescribeGlobalClustersInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::describe_global_clusters::DescribeGlobalClustersOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::describe_global_clusters::DescribeGlobalClustersError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::describe_global_clusters::DescribeGlobalClusters::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::describe_global_clusters::DescribeGlobalClusters::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::describe_global_clusters::DescribeGlobalClustersOutput,
99        crate::operation::describe_global_clusters::DescribeGlobalClustersError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// Create a paginator for this request
114    ///
115    /// Paginators are used by calling [`send().await`](crate::operation::describe_global_clusters::paginator::DescribeGlobalClustersPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
116    pub fn into_paginator(self) -> crate::operation::describe_global_clusters::paginator::DescribeGlobalClustersPaginator {
117        crate::operation::describe_global_clusters::paginator::DescribeGlobalClustersPaginator::new(self.handle, self.inner)
118    }
119    /// <p>The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.</p>
120    pub fn global_cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
121        self.inner = self.inner.global_cluster_identifier(input.into());
122        self
123    }
124    /// <p>The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.</p>
125    pub fn set_global_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
126        self.inner = self.inner.set_global_cluster_identifier(input);
127        self
128    }
129    /// <p>The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.</p>
130    pub fn get_global_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
131        self.inner.get_global_cluster_identifier()
132    }
133    ///
134    /// Appends an item to `Filters`.
135    ///
136    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
137    ///
138    /// <p>A filter that specifies one or more global DB clusters to describe.</p>
139    /// <p>Supported filters: <code>db-cluster-id</code> accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.</p>
140    pub fn filters(mut self, input: crate::types::Filter) -> Self {
141        self.inner = self.inner.filters(input);
142        self
143    }
144    /// <p>A filter that specifies one or more global DB clusters to describe.</p>
145    /// <p>Supported filters: <code>db-cluster-id</code> accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.</p>
146    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
147        self.inner = self.inner.set_filters(input);
148        self
149    }
150    /// <p>A filter that specifies one or more global DB clusters to describe.</p>
151    /// <p>Supported filters: <code>db-cluster-id</code> accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.</p>
152    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
153        self.inner.get_filters()
154    }
155    /// <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 called a marker is included in the response so that you can retrieve the remaining results.</p>
156    pub fn max_records(mut self, input: i32) -> Self {
157        self.inner = self.inner.max_records(input);
158        self
159    }
160    /// <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 called a marker is included in the response so that you can retrieve the remaining results.</p>
161    pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
162        self.inner = self.inner.set_max_records(input);
163        self
164    }
165    /// <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 called a marker is included in the response so that you can retrieve the remaining results.</p>
166    pub fn get_max_records(&self) -> &::std::option::Option<i32> {
167        self.inner.get_max_records()
168    }
169    /// <p>An optional pagination token provided by a previous <code>DescribeGlobalClusters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
170    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
171        self.inner = self.inner.marker(input.into());
172        self
173    }
174    /// <p>An optional pagination token provided by a previous <code>DescribeGlobalClusters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
175    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
176        self.inner = self.inner.set_marker(input);
177        self
178    }
179    /// <p>An optional pagination token provided by a previous <code>DescribeGlobalClusters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
180    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
181        self.inner.get_marker()
182    }
183}
aws_sdk_docdb/operation/describe_global_clusters/builders.rs

aws_sdk_docdb/operation/describe_global_clusters/
builders.rs
