aws_sdk_glue/operation/get_catalogs/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_catalogs::_get_catalogs_input::GetCatalogsInputBuilder;
3
4pub use crate::operation::get_catalogs::_get_catalogs_output::GetCatalogsOutputBuilder;
5
6impl crate::operation::get_catalogs::builders::GetCatalogsInputBuilder {
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::get_catalogs::GetCatalogsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::get_catalogs::GetCatalogsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.get_catalogs();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `GetCatalogs`.
24///
25/// <p>Retrieves all catalogs defined in a catalog in the Glue Data Catalog. For a Redshift-federated catalog use case, this operation returns the list of catalogs mapped to Redshift databases in the Redshift namespace catalog.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct GetCatalogsFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::get_catalogs::builders::GetCatalogsInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::get_catalogs::GetCatalogsOutput,
35 crate::operation::get_catalogs::GetCatalogsError,
36 > for GetCatalogsFluentBuilder
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::get_catalogs::GetCatalogsOutput,
44 crate::operation::get_catalogs::GetCatalogsError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl GetCatalogsFluentBuilder {
51 /// Creates a new `GetCatalogsFluentBuilder`.
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 GetCatalogs as a reference.
60 pub fn as_input(&self) -> &crate::operation::get_catalogs::builders::GetCatalogsInputBuilder {
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::get_catalogs::GetCatalogsOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::get_catalogs::GetCatalogsError,
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::get_catalogs::GetCatalogs::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::get_catalogs::GetCatalogs::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::get_catalogs::GetCatalogsOutput,
97 crate::operation::get_catalogs::GetCatalogsError,
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 /// <p>The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.</p>
112 pub fn parent_catalog_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113 self.inner = self.inner.parent_catalog_id(input.into());
114 self
115 }
116 /// <p>The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.</p>
117 pub fn set_parent_catalog_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118 self.inner = self.inner.set_parent_catalog_id(input);
119 self
120 }
121 /// <p>The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.</p>
122 pub fn get_parent_catalog_id(&self) -> &::std::option::Option<::std::string::String> {
123 self.inner.get_parent_catalog_id()
124 }
125 /// <p>A continuation token, if this is a continuation call.</p>
126 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127 self.inner = self.inner.next_token(input.into());
128 self
129 }
130 /// <p>A continuation token, if this is a continuation call.</p>
131 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132 self.inner = self.inner.set_next_token(input);
133 self
134 }
135 /// <p>A continuation token, if this is a continuation call.</p>
136 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
137 self.inner.get_next_token()
138 }
139 /// <p>The maximum number of catalogs to return in one response.</p>
140 pub fn max_results(mut self, input: i32) -> Self {
141 self.inner = self.inner.max_results(input);
142 self
143 }
144 /// <p>The maximum number of catalogs to return in one response.</p>
145 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
146 self.inner = self.inner.set_max_results(input);
147 self
148 }
149 /// <p>The maximum number of catalogs to return in one response.</p>
150 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
151 self.inner.get_max_results()
152 }
153 /// <p>Whether to list all catalogs across the catalog hierarchy, starting from the <code>ParentCatalogId</code>. Defaults to <code>false</code> . When <code>true</code>, all catalog objects in the <code>ParentCatalogID</code> hierarchy are enumerated in the response.</p>
154 pub fn recursive(mut self, input: bool) -> Self {
155 self.inner = self.inner.recursive(input);
156 self
157 }
158 /// <p>Whether to list all catalogs across the catalog hierarchy, starting from the <code>ParentCatalogId</code>. Defaults to <code>false</code> . When <code>true</code>, all catalog objects in the <code>ParentCatalogID</code> hierarchy are enumerated in the response.</p>
159 pub fn set_recursive(mut self, input: ::std::option::Option<bool>) -> Self {
160 self.inner = self.inner.set_recursive(input);
161 self
162 }
163 /// <p>Whether to list all catalogs across the catalog hierarchy, starting from the <code>ParentCatalogId</code>. Defaults to <code>false</code> . When <code>true</code>, all catalog objects in the <code>ParentCatalogID</code> hierarchy are enumerated in the response.</p>
164 pub fn get_recursive(&self) -> &::std::option::Option<bool> {
165 self.inner.get_recursive()
166 }
167 /// <p>Whether to list the default catalog in the account and region in the response. Defaults to <code>false</code>. When <code>true</code> and <code>ParentCatalogId = NULL | Amazon Web Services Account ID</code>, all catalogs and the default catalog are enumerated in the response.</p>
168 /// <p>When the <code>ParentCatalogId</code> is not equal to null, and this attribute is passed as <code>false</code> or <code>true</code>, an <code>InvalidInputException</code> is thrown.</p>
169 pub fn include_root(mut self, input: bool) -> Self {
170 self.inner = self.inner.include_root(input);
171 self
172 }
173 /// <p>Whether to list the default catalog in the account and region in the response. Defaults to <code>false</code>. When <code>true</code> and <code>ParentCatalogId = NULL | Amazon Web Services Account ID</code>, all catalogs and the default catalog are enumerated in the response.</p>
174 /// <p>When the <code>ParentCatalogId</code> is not equal to null, and this attribute is passed as <code>false</code> or <code>true</code>, an <code>InvalidInputException</code> is thrown.</p>
175 pub fn set_include_root(mut self, input: ::std::option::Option<bool>) -> Self {
176 self.inner = self.inner.set_include_root(input);
177 self
178 }
179 /// <p>Whether to list the default catalog in the account and region in the response. Defaults to <code>false</code>. When <code>true</code> and <code>ParentCatalogId = NULL | Amazon Web Services Account ID</code>, all catalogs and the default catalog are enumerated in the response.</p>
180 /// <p>When the <code>ParentCatalogId</code> is not equal to null, and this attribute is passed as <code>false</code> or <code>true</code>, an <code>InvalidInputException</code> is thrown.</p>
181 pub fn get_include_root(&self) -> &::std::option::Option<bool> {
182 self.inner.get_include_root()
183 }
184 /// <p>When <code>true</code>, the response only includes catalogs that can contain databases. Some catalogs are organizational containers that hold only other catalogs, not databases. When this parameter is set to <code>true</code>, those container-only catalogs are excluded, and only catalogs capable of containing databases are returned. Defaults to <code>false</code>.</p>
185 pub fn has_databases(mut self, input: bool) -> Self {
186 self.inner = self.inner.has_databases(input);
187 self
188 }
189 /// <p>When <code>true</code>, the response only includes catalogs that can contain databases. Some catalogs are organizational containers that hold only other catalogs, not databases. When this parameter is set to <code>true</code>, those container-only catalogs are excluded, and only catalogs capable of containing databases are returned. Defaults to <code>false</code>.</p>
190 pub fn set_has_databases(mut self, input: ::std::option::Option<bool>) -> Self {
191 self.inner = self.inner.set_has_databases(input);
192 self
193 }
194 /// <p>When <code>true</code>, the response only includes catalogs that can contain databases. Some catalogs are organizational containers that hold only other catalogs, not databases. When this parameter is set to <code>true</code>, those container-only catalogs are excluded, and only catalogs capable of containing databases are returned. Defaults to <code>false</code>.</p>
195 pub fn get_has_databases(&self) -> &::std::option::Option<bool> {
196 self.inner.get_has_databases()
197 }
198}