aws_sdk_databrew/operation/create_profile_job/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_profile_job::_create_profile_job_output::CreateProfileJobOutputBuilder;
3
4pub use crate::operation::create_profile_job::_create_profile_job_input::CreateProfileJobInputBuilder;
5
6impl crate::operation::create_profile_job::builders::CreateProfileJobInputBuilder {
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_profile_job::CreateProfileJobOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_profile_job::CreateProfileJobError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_profile_job();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateProfileJob`.
24///
25/// <p>Creates a new job to analyze a dataset and create its data profile.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateProfileJobFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_profile_job::builders::CreateProfileJobInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_profile_job::CreateProfileJobOutput,
35        crate::operation::create_profile_job::CreateProfileJobError,
36    > for CreateProfileJobFluentBuilder
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_profile_job::CreateProfileJobOutput,
44            crate::operation::create_profile_job::CreateProfileJobError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateProfileJobFluentBuilder {
51    /// Creates a new `CreateProfileJobFluentBuilder`.
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 CreateProfileJob as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_profile_job::builders::CreateProfileJobInputBuilder {
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_profile_job::CreateProfileJobOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_profile_job::CreateProfileJobError,
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_profile_job::CreateProfileJob::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_profile_job::CreateProfileJob::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_profile_job::CreateProfileJobOutput,
97        crate::operation::create_profile_job::CreateProfileJobError,
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 name of the dataset that this job is to act upon.</p>
112    pub fn dataset_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.dataset_name(input.into());
114        self
115    }
116    /// <p>The name of the dataset that this job is to act upon.</p>
117    pub fn set_dataset_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_dataset_name(input);
119        self
120    }
121    /// <p>The name of the dataset that this job is to act upon.</p>
122    pub fn get_dataset_name(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_dataset_name()
124    }
125    /// <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.</p>
126    pub fn encryption_key_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.encryption_key_arn(input.into());
128        self
129    }
130    /// <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.</p>
131    pub fn set_encryption_key_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_encryption_key_arn(input);
133        self
134    }
135    /// <p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.</p>
136    pub fn get_encryption_key_arn(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_encryption_key_arn()
138    }
139    /// <p>The encryption mode for the job, which can be one of the following:</p>
140    /// <ul>
141    /// <li>
142    /// <p><code>SSE-KMS</code> - <code>SSE-KMS</code> - Server-side encryption with KMS-managed keys.</p></li>
143    /// <li>
144    /// <p><code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p></li>
145    /// </ul>
146    pub fn encryption_mode(mut self, input: crate::types::EncryptionMode) -> Self {
147        self.inner = self.inner.encryption_mode(input);
148        self
149    }
150    /// <p>The encryption mode for the job, which can be one of the following:</p>
151    /// <ul>
152    /// <li>
153    /// <p><code>SSE-KMS</code> - <code>SSE-KMS</code> - Server-side encryption with KMS-managed keys.</p></li>
154    /// <li>
155    /// <p><code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p></li>
156    /// </ul>
157    pub fn set_encryption_mode(mut self, input: ::std::option::Option<crate::types::EncryptionMode>) -> Self {
158        self.inner = self.inner.set_encryption_mode(input);
159        self
160    }
161    /// <p>The encryption mode for the job, which can be one of the following:</p>
162    /// <ul>
163    /// <li>
164    /// <p><code>SSE-KMS</code> - <code>SSE-KMS</code> - Server-side encryption with KMS-managed keys.</p></li>
165    /// <li>
166    /// <p><code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p></li>
167    /// </ul>
168    pub fn get_encryption_mode(&self) -> &::std::option::Option<crate::types::EncryptionMode> {
169        self.inner.get_encryption_mode()
170    }
171    /// <p>The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>
172    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
173        self.inner = self.inner.name(input.into());
174        self
175    }
176    /// <p>The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>
177    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
178        self.inner = self.inner.set_name(input);
179        self
180    }
181    /// <p>The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>
182    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
183        self.inner.get_name()
184    }
185    /// <p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>
186    pub fn log_subscription(mut self, input: crate::types::LogSubscription) -> Self {
187        self.inner = self.inner.log_subscription(input);
188        self
189    }
190    /// <p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>
191    pub fn set_log_subscription(mut self, input: ::std::option::Option<crate::types::LogSubscription>) -> Self {
192        self.inner = self.inner.set_log_subscription(input);
193        self
194    }
195    /// <p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>
196    pub fn get_log_subscription(&self) -> &::std::option::Option<crate::types::LogSubscription> {
197        self.inner.get_log_subscription()
198    }
199    /// <p>The maximum number of nodes that DataBrew can use when the job processes data.</p>
200    pub fn max_capacity(mut self, input: i32) -> Self {
201        self.inner = self.inner.max_capacity(input);
202        self
203    }
204    /// <p>The maximum number of nodes that DataBrew can use when the job processes data.</p>
205    pub fn set_max_capacity(mut self, input: ::std::option::Option<i32>) -> Self {
206        self.inner = self.inner.set_max_capacity(input);
207        self
208    }
209    /// <p>The maximum number of nodes that DataBrew can use when the job processes data.</p>
210    pub fn get_max_capacity(&self) -> &::std::option::Option<i32> {
211        self.inner.get_max_capacity()
212    }
213    /// <p>The maximum number of times to retry the job after a job run fails.</p>
214    pub fn max_retries(mut self, input: i32) -> Self {
215        self.inner = self.inner.max_retries(input);
216        self
217    }
218    /// <p>The maximum number of times to retry the job after a job run fails.</p>
219    pub fn set_max_retries(mut self, input: ::std::option::Option<i32>) -> Self {
220        self.inner = self.inner.set_max_retries(input);
221        self
222    }
223    /// <p>The maximum number of times to retry the job after a job run fails.</p>
224    pub fn get_max_retries(&self) -> &::std::option::Option<i32> {
225        self.inner.get_max_retries()
226    }
227    /// <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.</p>
228    pub fn output_location(mut self, input: crate::types::S3Location) -> Self {
229        self.inner = self.inner.output_location(input);
230        self
231    }
232    /// <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.</p>
233    pub fn set_output_location(mut self, input: ::std::option::Option<crate::types::S3Location>) -> Self {
234        self.inner = self.inner.set_output_location(input);
235        self
236    }
237    /// <p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.</p>
238    pub fn get_output_location(&self) -> &::std::option::Option<crate::types::S3Location> {
239        self.inner.get_output_location()
240    }
241    /// <p>Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.</p>
242    pub fn configuration(mut self, input: crate::types::ProfileConfiguration) -> Self {
243        self.inner = self.inner.configuration(input);
244        self
245    }
246    /// <p>Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.</p>
247    pub fn set_configuration(mut self, input: ::std::option::Option<crate::types::ProfileConfiguration>) -> Self {
248        self.inner = self.inner.set_configuration(input);
249        self
250    }
251    /// <p>Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.</p>
252    pub fn get_configuration(&self) -> &::std::option::Option<crate::types::ProfileConfiguration> {
253        self.inner.get_configuration()
254    }
255    ///
256    /// Appends an item to `ValidationConfigurations`.
257    ///
258    /// To override the contents of this collection use [`set_validation_configurations`](Self::set_validation_configurations).
259    ///
260    /// <p>List of validation configurations that are applied to the profile job.</p>
261    pub fn validation_configurations(mut self, input: crate::types::ValidationConfiguration) -> Self {
262        self.inner = self.inner.validation_configurations(input);
263        self
264    }
265    /// <p>List of validation configurations that are applied to the profile job.</p>
266    pub fn set_validation_configurations(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ValidationConfiguration>>) -> Self {
267        self.inner = self.inner.set_validation_configurations(input);
268        self
269    }
270    /// <p>List of validation configurations that are applied to the profile job.</p>
271    pub fn get_validation_configurations(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ValidationConfiguration>> {
272        self.inner.get_validation_configurations()
273    }
274    /// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>
275    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
276        self.inner = self.inner.role_arn(input.into());
277        self
278    }
279    /// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>
280    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
281        self.inner = self.inner.set_role_arn(input);
282        self
283    }
284    /// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.</p>
285    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
286        self.inner.get_role_arn()
287    }
288    ///
289    /// Adds a key-value pair to `Tags`.
290    ///
291    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
292    ///
293    /// <p>Metadata tags to apply to this job.</p>
294    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
295        self.inner = self.inner.tags(k.into(), v.into());
296        self
297    }
298    /// <p>Metadata tags to apply to this job.</p>
299    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
300        self.inner = self.inner.set_tags(input);
301        self
302    }
303    /// <p>Metadata tags to apply to this job.</p>
304    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
305        self.inner.get_tags()
306    }
307    /// <p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>
308    pub fn timeout(mut self, input: i32) -> Self {
309        self.inner = self.inner.timeout(input);
310        self
311    }
312    /// <p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>
313    pub fn set_timeout(mut self, input: ::std::option::Option<i32>) -> Self {
314        self.inner = self.inner.set_timeout(input);
315        self
316    }
317    /// <p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>
318    pub fn get_timeout(&self) -> &::std::option::Option<i32> {
319        self.inner.get_timeout()
320    }
321    /// <p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>
322    pub fn job_sample(mut self, input: crate::types::JobSample) -> Self {
323        self.inner = self.inner.job_sample(input);
324        self
325    }
326    /// <p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>
327    pub fn set_job_sample(mut self, input: ::std::option::Option<crate::types::JobSample>) -> Self {
328        self.inner = self.inner.set_job_sample(input);
329        self
330    }
331    /// <p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>
332    pub fn get_job_sample(&self) -> &::std::option::Option<crate::types::JobSample> {
333        self.inner.get_job_sample()
334    }
335}
aws_sdk_databrew/operation/create_profile_job/builders.rs

aws_sdk_databrew/operation/create_profile_job/
builders.rs
