aws_sdk_appflow/operation/create_flow/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_flow::_create_flow_output::CreateFlowOutputBuilder;
3
4pub use crate::operation::create_flow::_create_flow_input::CreateFlowInputBuilder;
5
6impl crate::operation::create_flow::builders::CreateFlowInputBuilder {
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::create_flow::CreateFlowOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_flow::CreateFlowError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_flow();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateFlow`.
24///
25/// <p>Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateFlowFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_flow::builders::CreateFlowInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_flow::CreateFlowOutput,
35        crate::operation::create_flow::CreateFlowError,
36    > for CreateFlowFluentBuilder
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::create_flow::CreateFlowOutput,
44            crate::operation::create_flow::CreateFlowError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateFlowFluentBuilder {
51    /// Creates a new `CreateFlowFluentBuilder`.
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 CreateFlow as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_flow::builders::CreateFlowInputBuilder {
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::create_flow::CreateFlowOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_flow::CreateFlowError,
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::create_flow::CreateFlow::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_flow::CreateFlow::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::create_flow::CreateFlowOutput,
97        crate::operation::create_flow::CreateFlowError,
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 specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.</p>
112    pub fn flow_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.flow_name(input.into());
114        self
115    }
116    /// <p>The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.</p>
117    pub fn set_flow_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_flow_name(input);
119        self
120    }
121    /// <p>The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.</p>
122    pub fn get_flow_name(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_flow_name()
124    }
125    /// <p>A description of the flow you want to create.</p>
126    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.description(input.into());
128        self
129    }
130    /// <p>A description of the flow you want to create.</p>
131    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_description(input);
133        self
134    }
135    /// <p>A description of the flow you want to create.</p>
136    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_description()
138    }
139    /// <p>The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.</p>
140    pub fn kms_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.kms_arn(input.into());
142        self
143    }
144    /// <p>The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.</p>
145    pub fn set_kms_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_kms_arn(input);
147        self
148    }
149    /// <p>The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.</p>
150    pub fn get_kms_arn(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_kms_arn()
152    }
153    /// <p>The trigger settings that determine how and when the flow runs.</p>
154    pub fn trigger_config(mut self, input: crate::types::TriggerConfig) -> Self {
155        self.inner = self.inner.trigger_config(input);
156        self
157    }
158    /// <p>The trigger settings that determine how and when the flow runs.</p>
159    pub fn set_trigger_config(mut self, input: ::std::option::Option<crate::types::TriggerConfig>) -> Self {
160        self.inner = self.inner.set_trigger_config(input);
161        self
162    }
163    /// <p>The trigger settings that determine how and when the flow runs.</p>
164    pub fn get_trigger_config(&self) -> &::std::option::Option<crate::types::TriggerConfig> {
165        self.inner.get_trigger_config()
166    }
167    /// <p>The configuration that controls how Amazon AppFlow retrieves data from the source connector.</p>
168    pub fn source_flow_config(mut self, input: crate::types::SourceFlowConfig) -> Self {
169        self.inner = self.inner.source_flow_config(input);
170        self
171    }
172    /// <p>The configuration that controls how Amazon AppFlow retrieves data from the source connector.</p>
173    pub fn set_source_flow_config(mut self, input: ::std::option::Option<crate::types::SourceFlowConfig>) -> Self {
174        self.inner = self.inner.set_source_flow_config(input);
175        self
176    }
177    /// <p>The configuration that controls how Amazon AppFlow retrieves data from the source connector.</p>
178    pub fn get_source_flow_config(&self) -> &::std::option::Option<crate::types::SourceFlowConfig> {
179        self.inner.get_source_flow_config()
180    }
181    ///
182    /// Appends an item to `destinationFlowConfigList`.
183    ///
184    /// To override the contents of this collection use [`set_destination_flow_config_list`](Self::set_destination_flow_config_list).
185    ///
186    /// <p>The configuration that controls how Amazon AppFlow places data in the destination connector.</p>
187    pub fn destination_flow_config_list(mut self, input: crate::types::DestinationFlowConfig) -> Self {
188        self.inner = self.inner.destination_flow_config_list(input);
189        self
190    }
191    /// <p>The configuration that controls how Amazon AppFlow places data in the destination connector.</p>
192    pub fn set_destination_flow_config_list(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DestinationFlowConfig>>) -> Self {
193        self.inner = self.inner.set_destination_flow_config_list(input);
194        self
195    }
196    /// <p>The configuration that controls how Amazon AppFlow places data in the destination connector.</p>
197    pub fn get_destination_flow_config_list(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DestinationFlowConfig>> {
198        self.inner.get_destination_flow_config_list()
199    }
200    ///
201    /// Appends an item to `tasks`.
202    ///
203    /// To override the contents of this collection use [`set_tasks`](Self::set_tasks).
204    ///
205    /// <p>A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.</p>
206    pub fn tasks(mut self, input: crate::types::Task) -> Self {
207        self.inner = self.inner.tasks(input);
208        self
209    }
210    /// <p>A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.</p>
211    pub fn set_tasks(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Task>>) -> Self {
212        self.inner = self.inner.set_tasks(input);
213        self
214    }
215    /// <p>A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.</p>
216    pub fn get_tasks(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Task>> {
217        self.inner.get_tasks()
218    }
219    ///
220    /// Adds a key-value pair to `tags`.
221    ///
222    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
223    ///
224    /// <p>The tags used to organize, track, or control access for your flow.</p>
225    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
226        self.inner = self.inner.tags(k.into(), v.into());
227        self
228    }
229    /// <p>The tags used to organize, track, or control access for your flow.</p>
230    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
231        self.inner = self.inner.set_tags(input);
232        self
233    }
234    /// <p>The tags used to organize, track, or control access for your flow.</p>
235    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
236        self.inner.get_tags()
237    }
238    /// <p>Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.</p>
239    pub fn metadata_catalog_config(mut self, input: crate::types::MetadataCatalogConfig) -> Self {
240        self.inner = self.inner.metadata_catalog_config(input);
241        self
242    }
243    /// <p>Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.</p>
244    pub fn set_metadata_catalog_config(mut self, input: ::std::option::Option<crate::types::MetadataCatalogConfig>) -> Self {
245        self.inner = self.inner.set_metadata_catalog_config(input);
246        self
247    }
248    /// <p>Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.</p>
249    pub fn get_metadata_catalog_config(&self) -> &::std::option::Option<crate::types::MetadataCatalogConfig> {
250        self.inner.get_metadata_catalog_config()
251    }
252    /// <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>CreateFlow</code> request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same <code>clientToken</code> parameter value.</p>
253    /// <p>If you omit a <code>clientToken</code> value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.</p>
254    /// <p>If you specify input parameters that differ from your first request, an error occurs. If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>CreateFlow</code>. The token is active for 8 hours.</p>
255    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
256        self.inner = self.inner.client_token(input.into());
257        self
258    }
259    /// <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>CreateFlow</code> request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same <code>clientToken</code> parameter value.</p>
260    /// <p>If you omit a <code>clientToken</code> value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.</p>
261    /// <p>If you specify input parameters that differ from your first request, an error occurs. If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>CreateFlow</code>. The token is active for 8 hours.</p>
262    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
263        self.inner = self.inner.set_client_token(input);
264        self
265    }
266    /// <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>CreateFlow</code> request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same <code>clientToken</code> parameter value.</p>
267    /// <p>If you omit a <code>clientToken</code> value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.</p>
268    /// <p>If you specify input parameters that differ from your first request, an error occurs. If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>CreateFlow</code>. The token is active for 8 hours.</p>
269    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
270        self.inner.get_client_token()
271    }
272}