aws_sdk_rds/operation/describe_db_parameters/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_db_parameters::_describe_db_parameters_output::DescribeDbParametersOutputBuilder;
3
4pub use crate::operation::describe_db_parameters::_describe_db_parameters_input::DescribeDbParametersInputBuilder;
5
6impl crate::operation::describe_db_parameters::builders::DescribeDbParametersInputBuilder {
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_parameters::DescribeDbParametersOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_db_parameters::DescribeDBParametersError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_db_parameters();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeDBParameters`.
24///
25/// <p>Returns the detailed parameter list for a particular DB parameter group.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DescribeDBParametersFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::describe_db_parameters::builders::DescribeDbParametersInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::describe_db_parameters::DescribeDbParametersOutput,
35        crate::operation::describe_db_parameters::DescribeDBParametersError,
36    > for DescribeDBParametersFluentBuilder
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_parameters::DescribeDbParametersOutput,
44            crate::operation::describe_db_parameters::DescribeDBParametersError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl DescribeDBParametersFluentBuilder {
51    /// Creates a new `DescribeDBParametersFluentBuilder`.
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 DescribeDBParameters as a reference.
60    pub fn as_input(&self) -> &crate::operation::describe_db_parameters::builders::DescribeDbParametersInputBuilder {
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_parameters::DescribeDbParametersOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::describe_db_parameters::DescribeDBParametersError,
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_parameters::DescribeDBParameters::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::describe_db_parameters::DescribeDBParameters::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_parameters::DescribeDbParametersOutput,
97        crate::operation::describe_db_parameters::DescribeDBParametersError,
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_parameters::paginator::DescribeDbParametersPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::describe_db_parameters::paginator::DescribeDbParametersPaginator {
115        crate::operation::describe_db_parameters::paginator::DescribeDbParametersPaginator::new(self.handle, self.inner)
116    }
117    /// <p>The name of a specific DB parameter group to return details for.</p>
118    /// <p>Constraints:</p>
119    /// <ul>
120    /// <li>
121    /// <p>If supplied, must match the name of an existing DBParameterGroup.</p></li>
122    /// </ul>
123    pub fn db_parameter_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
124        self.inner = self.inner.db_parameter_group_name(input.into());
125        self
126    }
127    /// <p>The name of a specific DB parameter group to return details for.</p>
128    /// <p>Constraints:</p>
129    /// <ul>
130    /// <li>
131    /// <p>If supplied, must match the name of an existing DBParameterGroup.</p></li>
132    /// </ul>
133    pub fn set_db_parameter_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_db_parameter_group_name(input);
135        self
136    }
137    /// <p>The name of a specific DB parameter group to return details for.</p>
138    /// <p>Constraints:</p>
139    /// <ul>
140    /// <li>
141    /// <p>If supplied, must match the name of an existing DBParameterGroup.</p></li>
142    /// </ul>
143    pub fn get_db_parameter_group_name(&self) -> &::std::option::Option<::std::string::String> {
144        self.inner.get_db_parameter_group_name()
145    }
146    /// <p>The parameter types to return.</p>
147    /// <p>Default: All parameter types returned</p>
148    /// <p>Valid Values: <code>user | system | engine-default</code></p>
149    pub fn source(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
150        self.inner = self.inner.source(input.into());
151        self
152    }
153    /// <p>The parameter types to return.</p>
154    /// <p>Default: All parameter types returned</p>
155    /// <p>Valid Values: <code>user | system | engine-default</code></p>
156    pub fn set_source(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
157        self.inner = self.inner.set_source(input);
158        self
159    }
160    /// <p>The parameter types to return.</p>
161    /// <p>Default: All parameter types returned</p>
162    /// <p>Valid Values: <code>user | system | engine-default</code></p>
163    pub fn get_source(&self) -> &::std::option::Option<::std::string::String> {
164        self.inner.get_source()
165    }
166    ///
167    /// Appends an item to `Filters`.
168    ///
169    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
170    ///
171    /// <p>A filter that specifies one or more DB parameters to describe.</p>
172    /// <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the DB parameters with these names.</p>
173    pub fn filters(mut self, input: crate::types::Filter) -> Self {
174        self.inner = self.inner.filters(input);
175        self
176    }
177    /// <p>A filter that specifies one or more DB parameters to describe.</p>
178    /// <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the DB parameters with these names.</p>
179    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
180        self.inner = self.inner.set_filters(input);
181        self
182    }
183    /// <p>A filter that specifies one or more DB parameters to describe.</p>
184    /// <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the DB parameters with these names.</p>
185    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
186        self.inner.get_filters()
187    }
188    /// <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>
189    /// <p>Default: 100</p>
190    /// <p>Constraints: Minimum 20, maximum 100.</p>
191    pub fn max_records(mut self, input: i32) -> Self {
192        self.inner = self.inner.max_records(input);
193        self
194    }
195    /// <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>
196    /// <p>Default: 100</p>
197    /// <p>Constraints: Minimum 20, maximum 100.</p>
198    pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
199        self.inner = self.inner.set_max_records(input);
200        self
201    }
202    /// <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>
203    /// <p>Default: 100</p>
204    /// <p>Constraints: Minimum 20, maximum 100.</p>
205    pub fn get_max_records(&self) -> &::std::option::Option<i32> {
206        self.inner.get_max_records()
207    }
208    /// <p>An optional pagination token provided by a previous <code>DescribeDBParameters</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>
209    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
210        self.inner = self.inner.marker(input.into());
211        self
212    }
213    /// <p>An optional pagination token provided by a previous <code>DescribeDBParameters</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>
214    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
215        self.inner = self.inner.set_marker(input);
216        self
217    }
218    /// <p>An optional pagination token provided by a previous <code>DescribeDBParameters</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>
219    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
220        self.inner.get_marker()
221    }
222}