aws_sdk_rds/operation/describe_db_cluster_endpoints/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_db_cluster_endpoints::_describe_db_cluster_endpoints_output::DescribeDbClusterEndpointsOutputBuilder;
3
4pub use crate::operation::describe_db_cluster_endpoints::_describe_db_cluster_endpoints_input::DescribeDbClusterEndpointsInputBuilder;
5
6impl crate::operation::describe_db_cluster_endpoints::builders::DescribeDbClusterEndpointsInputBuilder {
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_cluster_endpoints::DescribeDbClusterEndpointsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_db_cluster_endpoints::DescribeDBClusterEndpointsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_db_cluster_endpoints();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeDBClusterEndpoints`.
24///
25/// <p>Returns information about endpoints for an Amazon Aurora DB cluster.</p><note>
26/// <p>This action only applies to Aurora DB clusters.</p>
27/// </note>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct DescribeDBClusterEndpointsFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::describe_db_cluster_endpoints::builders::DescribeDbClusterEndpointsInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::describe_db_cluster_endpoints::DescribeDbClusterEndpointsOutput,
37        crate::operation::describe_db_cluster_endpoints::DescribeDBClusterEndpointsError,
38    > for DescribeDBClusterEndpointsFluentBuilder
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_db_cluster_endpoints::DescribeDbClusterEndpointsOutput,
46            crate::operation::describe_db_cluster_endpoints::DescribeDBClusterEndpointsError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl DescribeDBClusterEndpointsFluentBuilder {
53    /// Creates a new `DescribeDBClusterEndpointsFluentBuilder`.
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 DescribeDBClusterEndpoints as a reference.
62    pub fn as_input(&self) -> &crate::operation::describe_db_cluster_endpoints::builders::DescribeDbClusterEndpointsInputBuilder {
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_db_cluster_endpoints::DescribeDbClusterEndpointsOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::describe_db_cluster_endpoints::DescribeDBClusterEndpointsError,
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_db_cluster_endpoints::DescribeDBClusterEndpoints::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::describe_db_cluster_endpoints::DescribeDBClusterEndpoints::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_db_cluster_endpoints::DescribeDbClusterEndpointsOutput,
99        crate::operation::describe_db_cluster_endpoints::DescribeDBClusterEndpointsError,
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_db_cluster_endpoints::paginator::DescribeDbClusterEndpointsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
116    pub fn into_paginator(self) -> crate::operation::describe_db_cluster_endpoints::paginator::DescribeDbClusterEndpointsPaginator {
117        crate::operation::describe_db_cluster_endpoints::paginator::DescribeDbClusterEndpointsPaginator::new(self.handle, self.inner)
118    }
119    /// <p>The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.</p>
120    pub fn db_cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
121        self.inner = self.inner.db_cluster_identifier(input.into());
122        self
123    }
124    /// <p>The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.</p>
125    pub fn set_db_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
126        self.inner = self.inner.set_db_cluster_identifier(input);
127        self
128    }
129    /// <p>The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.</p>
130    pub fn get_db_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
131        self.inner.get_db_cluster_identifier()
132    }
133    /// <p>The identifier of the endpoint to describe. This parameter is stored as a lowercase string.</p>
134    pub fn db_cluster_endpoint_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
135        self.inner = self.inner.db_cluster_endpoint_identifier(input.into());
136        self
137    }
138    /// <p>The identifier of the endpoint to describe. This parameter is stored as a lowercase string.</p>
139    pub fn set_db_cluster_endpoint_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
140        self.inner = self.inner.set_db_cluster_endpoint_identifier(input);
141        self
142    }
143    /// <p>The identifier of the endpoint to describe. This parameter is stored as a lowercase string.</p>
144    pub fn get_db_cluster_endpoint_identifier(&self) -> &::std::option::Option<::std::string::String> {
145        self.inner.get_db_cluster_endpoint_identifier()
146    }
147    ///
148    /// Appends an item to `Filters`.
149    ///
150    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
151    ///
152    /// <p>A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format <code>Name=<i>endpoint_type</i>,Values=<i>endpoint_type1</i>,<i>endpoint_type2</i>,...</code>. <code>Name</code> can be one of: <code>db-cluster-endpoint-type</code>, <code>db-cluster-endpoint-custom-type</code>, <code>db-cluster-endpoint-id</code>, <code>db-cluster-endpoint-status</code>. <code>Values</code> for the <code> db-cluster-endpoint-type</code> filter can be one or more of: <code>reader</code>, <code>writer</code>, <code>custom</code>. <code>Values</code> for the <code>db-cluster-endpoint-custom-type</code> filter can be one or more of: <code>reader</code>, <code>any</code>. <code>Values</code> for the <code>db-cluster-endpoint-status</code> filter can be one or more of: <code>available</code>, <code>creating</code>, <code>deleting</code>, <code>inactive</code>, <code>modifying</code>.</p>
153    pub fn filters(mut self, input: crate::types::Filter) -> Self {
154        self.inner = self.inner.filters(input);
155        self
156    }
157    /// <p>A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format <code>Name=<i>endpoint_type</i>,Values=<i>endpoint_type1</i>,<i>endpoint_type2</i>,...</code>. <code>Name</code> can be one of: <code>db-cluster-endpoint-type</code>, <code>db-cluster-endpoint-custom-type</code>, <code>db-cluster-endpoint-id</code>, <code>db-cluster-endpoint-status</code>. <code>Values</code> for the <code> db-cluster-endpoint-type</code> filter can be one or more of: <code>reader</code>, <code>writer</code>, <code>custom</code>. <code>Values</code> for the <code>db-cluster-endpoint-custom-type</code> filter can be one or more of: <code>reader</code>, <code>any</code>. <code>Values</code> for the <code>db-cluster-endpoint-status</code> filter can be one or more of: <code>available</code>, <code>creating</code>, <code>deleting</code>, <code>inactive</code>, <code>modifying</code>.</p>
158    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
159        self.inner = self.inner.set_filters(input);
160        self
161    }
162    /// <p>A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format <code>Name=<i>endpoint_type</i>,Values=<i>endpoint_type1</i>,<i>endpoint_type2</i>,...</code>. <code>Name</code> can be one of: <code>db-cluster-endpoint-type</code>, <code>db-cluster-endpoint-custom-type</code>, <code>db-cluster-endpoint-id</code>, <code>db-cluster-endpoint-status</code>. <code>Values</code> for the <code> db-cluster-endpoint-type</code> filter can be one or more of: <code>reader</code>, <code>writer</code>, <code>custom</code>. <code>Values</code> for the <code>db-cluster-endpoint-custom-type</code> filter can be one or more of: <code>reader</code>, <code>any</code>. <code>Values</code> for the <code>db-cluster-endpoint-status</code> filter can be one or more of: <code>available</code>, <code>creating</code>, <code>deleting</code>, <code>inactive</code>, <code>modifying</code>.</p>
163    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
164        self.inner.get_filters()
165    }
166    /// <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 you can retrieve the remaining results.</p>
167    /// <p>Default: 100</p>
168    /// <p>Constraints: Minimum 20, maximum 100.</p>
169    pub fn max_records(mut self, input: i32) -> Self {
170        self.inner = self.inner.max_records(input);
171        self
172    }
173    /// <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 you can retrieve the remaining results.</p>
174    /// <p>Default: 100</p>
175    /// <p>Constraints: Minimum 20, maximum 100.</p>
176    pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
177        self.inner = self.inner.set_max_records(input);
178        self
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 called a marker is included in the response so you can retrieve the remaining results.</p>
181    /// <p>Default: 100</p>
182    /// <p>Constraints: Minimum 20, maximum 100.</p>
183    pub fn get_max_records(&self) -> &::std::option::Option<i32> {
184        self.inner.get_max_records()
185    }
186    /// <p>An optional pagination token provided by a previous <code>DescribeDBClusterEndpoints</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>
187    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
188        self.inner = self.inner.marker(input.into());
189        self
190    }
191    /// <p>An optional pagination token provided by a previous <code>DescribeDBClusterEndpoints</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>
192    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
193        self.inner = self.inner.set_marker(input);
194        self
195    }
196    /// <p>An optional pagination token provided by a previous <code>DescribeDBClusterEndpoints</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>
197    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
198        self.inner.get_marker()
199    }
200}