aws_sdk_glue/operation/get_entity_records/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_entity_records::_get_entity_records_input::GetEntityRecordsInputBuilder;
3
4pub use crate::operation::get_entity_records::_get_entity_records_output::GetEntityRecordsOutputBuilder;
5
6impl crate::operation::get_entity_records::builders::GetEntityRecordsInputBuilder {
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_entity_records::GetEntityRecordsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_entity_records::GetEntityRecordsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_entity_records();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetEntityRecords`.
24///
25/// <p>This API is used to query preview data from a given connection type or from a native Amazon S3 based Glue Data Catalog.</p>
26/// <p>Returns records as an array of JSON blobs. Each record is formatted using Jackson JsonNode based on the field type defined by the <code>DescribeEntity</code> API.</p>
27/// <p>Spark connectors generate schemas according to the same data type mapping as in the <code>DescribeEntity</code> API. Spark connectors convert data to the appropriate data types matching the schema when returning rows.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct GetEntityRecordsFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::get_entity_records::builders::GetEntityRecordsInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::get_entity_records::GetEntityRecordsOutput,
37        crate::operation::get_entity_records::GetEntityRecordsError,
38    > for GetEntityRecordsFluentBuilder
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::get_entity_records::GetEntityRecordsOutput,
46            crate::operation::get_entity_records::GetEntityRecordsError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl GetEntityRecordsFluentBuilder {
53    /// Creates a new `GetEntityRecordsFluentBuilder`.
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 GetEntityRecords as a reference.
62    pub fn as_input(&self) -> &crate::operation::get_entity_records::builders::GetEntityRecordsInputBuilder {
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::get_entity_records::GetEntityRecordsOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::get_entity_records::GetEntityRecordsError,
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::get_entity_records::GetEntityRecords::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::get_entity_records::GetEntityRecords::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::get_entity_records::GetEntityRecordsOutput,
99        crate::operation::get_entity_records::GetEntityRecordsError,
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    /// <p>The name of the connection that contains the connection type credentials.</p>
114    pub fn connection_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.connection_name(input.into());
116        self
117    }
118    /// <p>The name of the connection that contains the connection type credentials.</p>
119    pub fn set_connection_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_connection_name(input);
121        self
122    }
123    /// <p>The name of the connection that contains the connection type credentials.</p>
124    pub fn get_connection_name(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_connection_name()
126    }
127    /// <p>The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.</p>
128    pub fn catalog_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.inner = self.inner.catalog_id(input.into());
130        self
131    }
132    /// <p>The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.</p>
133    pub fn set_catalog_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_catalog_id(input);
135        self
136    }
137    /// <p>The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.</p>
138    pub fn get_catalog_id(&self) -> &::std::option::Option<::std::string::String> {
139        self.inner.get_catalog_id()
140    }
141    /// <p>Name of the entity that we want to query the preview data from the given connection type.</p>
142    pub fn entity_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.inner = self.inner.entity_name(input.into());
144        self
145    }
146    /// <p>Name of the entity that we want to query the preview data from the given connection type.</p>
147    pub fn set_entity_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.inner = self.inner.set_entity_name(input);
149        self
150    }
151    /// <p>Name of the entity that we want to query the preview data from the given connection type.</p>
152    pub fn get_entity_name(&self) -> &::std::option::Option<::std::string::String> {
153        self.inner.get_entity_name()
154    }
155    /// <p>A continuation token, included if this is a continuation call.</p>
156    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
157        self.inner = self.inner.next_token(input.into());
158        self
159    }
160    /// <p>A continuation token, included if this is a continuation call.</p>
161    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
162        self.inner = self.inner.set_next_token(input);
163        self
164    }
165    /// <p>A continuation token, included if this is a continuation call.</p>
166    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
167        self.inner.get_next_token()
168    }
169    /// <p>The API version of the SaaS connector.</p>
170    pub fn data_store_api_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
171        self.inner = self.inner.data_store_api_version(input.into());
172        self
173    }
174    /// <p>The API version of the SaaS connector.</p>
175    pub fn set_data_store_api_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
176        self.inner = self.inner.set_data_store_api_version(input);
177        self
178    }
179    /// <p>The API version of the SaaS connector.</p>
180    pub fn get_data_store_api_version(&self) -> &::std::option::Option<::std::string::String> {
181        self.inner.get_data_store_api_version()
182    }
183    ///
184    /// Adds a key-value pair to `ConnectionOptions`.
185    ///
186    /// To override the contents of this collection use [`set_connection_options`](Self::set_connection_options).
187    ///
188    /// <p>Connector options that are required to query the data.</p>
189    pub fn connection_options(
190        mut self,
191        k: impl ::std::convert::Into<::std::string::String>,
192        v: impl ::std::convert::Into<::std::string::String>,
193    ) -> Self {
194        self.inner = self.inner.connection_options(k.into(), v.into());
195        self
196    }
197    /// <p>Connector options that are required to query the data.</p>
198    pub fn set_connection_options(
199        mut self,
200        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
201    ) -> Self {
202        self.inner = self.inner.set_connection_options(input);
203        self
204    }
205    /// <p>Connector options that are required to query the data.</p>
206    pub fn get_connection_options(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
207        self.inner.get_connection_options()
208    }
209    /// <p>A filter predicate that you can apply in the query request.</p>
210    pub fn filter_predicate(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
211        self.inner = self.inner.filter_predicate(input.into());
212        self
213    }
214    /// <p>A filter predicate that you can apply in the query request.</p>
215    pub fn set_filter_predicate(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
216        self.inner = self.inner.set_filter_predicate(input);
217        self
218    }
219    /// <p>A filter predicate that you can apply in the query request.</p>
220    pub fn get_filter_predicate(&self) -> &::std::option::Option<::std::string::String> {
221        self.inner.get_filter_predicate()
222    }
223    /// <p>Limits the number of records fetched with the request.</p>
224    pub fn limit(mut self, input: i64) -> Self {
225        self.inner = self.inner.limit(input);
226        self
227    }
228    /// <p>Limits the number of records fetched with the request.</p>
229    pub fn set_limit(mut self, input: ::std::option::Option<i64>) -> Self {
230        self.inner = self.inner.set_limit(input);
231        self
232    }
233    /// <p>Limits the number of records fetched with the request.</p>
234    pub fn get_limit(&self) -> &::std::option::Option<i64> {
235        self.inner.get_limit()
236    }
237    /// <p>A parameter that orders the response preview data.</p>
238    pub fn order_by(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
239        self.inner = self.inner.order_by(input.into());
240        self
241    }
242    /// <p>A parameter that orders the response preview data.</p>
243    pub fn set_order_by(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
244        self.inner = self.inner.set_order_by(input);
245        self
246    }
247    /// <p>A parameter that orders the response preview data.</p>
248    pub fn get_order_by(&self) -> &::std::option::Option<::std::string::String> {
249        self.inner.get_order_by()
250    }
251    ///
252    /// Appends an item to `SelectedFields`.
253    ///
254    /// To override the contents of this collection use [`set_selected_fields`](Self::set_selected_fields).
255    ///
256    /// <p>List of fields that we want to fetch as part of preview data.</p>
257    pub fn selected_fields(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
258        self.inner = self.inner.selected_fields(input.into());
259        self
260    }
261    /// <p>List of fields that we want to fetch as part of preview data.</p>
262    pub fn set_selected_fields(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
263        self.inner = self.inner.set_selected_fields(input);
264        self
265    }
266    /// <p>List of fields that we want to fetch as part of preview data.</p>
267    pub fn get_selected_fields(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
268        self.inner.get_selected_fields()
269    }
270}
aws_sdk_glue/operation/get_entity_records/builders.rs

aws_sdk_glue/operation/get_entity_records/
builders.rs
