aws_sdk_personalize/operation/create_batch_segment_job/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_batch_segment_job::_create_batch_segment_job_output::CreateBatchSegmentJobOutputBuilder;
3
4pub use crate::operation::create_batch_segment_job::_create_batch_segment_job_input::CreateBatchSegmentJobInputBuilder;
5
6impl crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobInputBuilder {
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_batch_segment_job::CreateBatchSegmentJobOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_batch_segment_job::CreateBatchSegmentJobError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_batch_segment_job();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateBatchSegmentJob`.
24///
25/// <p>Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html">Getting batch recommendations and user segments</a>.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateBatchSegmentJobFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_batch_segment_job::CreateBatchSegmentJobOutput,
35        crate::operation::create_batch_segment_job::CreateBatchSegmentJobError,
36    > for CreateBatchSegmentJobFluentBuilder
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_batch_segment_job::CreateBatchSegmentJobOutput,
44            crate::operation::create_batch_segment_job::CreateBatchSegmentJobError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateBatchSegmentJobFluentBuilder {
51    /// Creates a new `CreateBatchSegmentJobFluentBuilder`.
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 CreateBatchSegmentJob as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_batch_segment_job::builders::CreateBatchSegmentJobInputBuilder {
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_batch_segment_job::CreateBatchSegmentJobOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_batch_segment_job::CreateBatchSegmentJobError,
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_batch_segment_job::CreateBatchSegmentJob::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_batch_segment_job::CreateBatchSegmentJob::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_batch_segment_job::CreateBatchSegmentJobOutput,
97        crate::operation::create_batch_segment_job::CreateBatchSegmentJobError,
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 batch segment job to create.</p>
112    pub fn job_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.job_name(input.into());
114        self
115    }
116    /// <p>The name of the batch segment job to create.</p>
117    pub fn set_job_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_job_name(input);
119        self
120    }
121    /// <p>The name of the batch segment job to create.</p>
122    pub fn get_job_name(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_job_name()
124    }
125    /// <p>The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.</p>
126    pub fn solution_version_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.solution_version_arn(input.into());
128        self
129    }
130    /// <p>The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.</p>
131    pub fn set_solution_version_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_solution_version_arn(input);
133        self
134    }
135    /// <p>The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.</p>
136    pub fn get_solution_version_arn(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_solution_version_arn()
138    }
139    /// <p>The ARN of the filter to apply to the batch segment job. For more information on using filters, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html">Filtering batch recommendations</a>.</p>
140    pub fn filter_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.filter_arn(input.into());
142        self
143    }
144    /// <p>The ARN of the filter to apply to the batch segment job. For more information on using filters, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html">Filtering batch recommendations</a>.</p>
145    pub fn set_filter_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_filter_arn(input);
147        self
148    }
149    /// <p>The ARN of the filter to apply to the batch segment job. For more information on using filters, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html">Filtering batch recommendations</a>.</p>
150    pub fn get_filter_arn(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_filter_arn()
152    }
153    /// <p>The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.</p>
154    pub fn num_results(mut self, input: i32) -> Self {
155        self.inner = self.inner.num_results(input);
156        self
157    }
158    /// <p>The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.</p>
159    pub fn set_num_results(mut self, input: ::std::option::Option<i32>) -> Self {
160        self.inner = self.inner.set_num_results(input);
161        self
162    }
163    /// <p>The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.</p>
164    pub fn get_num_results(&self) -> &::std::option::Option<i32> {
165        self.inner.get_num_results()
166    }
167    /// <p>The Amazon S3 path for the input data used to generate the batch segment job.</p>
168    pub fn job_input(mut self, input: crate::types::BatchSegmentJobInput) -> Self {
169        self.inner = self.inner.job_input(input);
170        self
171    }
172    /// <p>The Amazon S3 path for the input data used to generate the batch segment job.</p>
173    pub fn set_job_input(mut self, input: ::std::option::Option<crate::types::BatchSegmentJobInput>) -> Self {
174        self.inner = self.inner.set_job_input(input);
175        self
176    }
177    /// <p>The Amazon S3 path for the input data used to generate the batch segment job.</p>
178    pub fn get_job_input(&self) -> &::std::option::Option<crate::types::BatchSegmentJobInput> {
179        self.inner.get_job_input()
180    }
181    /// <p>The Amazon S3 path for the bucket where the job's output will be stored.</p>
182    pub fn job_output(mut self, input: crate::types::BatchSegmentJobOutput) -> Self {
183        self.inner = self.inner.job_output(input);
184        self
185    }
186    /// <p>The Amazon S3 path for the bucket where the job's output will be stored.</p>
187    pub fn set_job_output(mut self, input: ::std::option::Option<crate::types::BatchSegmentJobOutput>) -> Self {
188        self.inner = self.inner.set_job_output(input);
189        self
190    }
191    /// <p>The Amazon S3 path for the bucket where the job's output will be stored.</p>
192    pub fn get_job_output(&self) -> &::std::option::Option<crate::types::BatchSegmentJobOutput> {
193        self.inner.get_job_output()
194    }
195    /// <p>The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.</p>
196    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
197        self.inner = self.inner.role_arn(input.into());
198        self
199    }
200    /// <p>The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.</p>
201    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
202        self.inner = self.inner.set_role_arn(input);
203        self
204    }
205    /// <p>The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.</p>
206    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
207        self.inner.get_role_arn()
208    }
209    ///
210    /// Appends an item to `tags`.
211    ///
212    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
213    ///
214    /// <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the batch segment job.</p>
215    pub fn tags(mut self, input: crate::types::Tag) -> Self {
216        self.inner = self.inner.tags(input);
217        self
218    }
219    /// <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the batch segment job.</p>
220    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
221        self.inner = self.inner.set_tags(input);
222        self
223    }
224    /// <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the batch segment job.</p>
225    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
226        self.inner.get_tags()
227    }
228}
aws_sdk_personalize/operation/create_batch_segment_job/builders.rs

aws_sdk_personalize/operation/create_batch_segment_job/
builders.rs
