aws_sdk_connect/operation/start_contact_evaluation/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_contact_evaluation::_start_contact_evaluation_output::StartContactEvaluationOutputBuilder;
3
4pub use crate::operation::start_contact_evaluation::_start_contact_evaluation_input::StartContactEvaluationInputBuilder;
5
6impl crate::operation::start_contact_evaluation::builders::StartContactEvaluationInputBuilder {
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::start_contact_evaluation::StartContactEvaluationOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::start_contact_evaluation::StartContactEvaluationError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.start_contact_evaluation();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StartContactEvaluation`.
24///
25/// <p>Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.</p><note>
26/// <p>Evaluations created through the public API do not contain answer values suggested from automation.</p>
27/// </note>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct StartContactEvaluationFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::start_contact_evaluation::builders::StartContactEvaluationInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::start_contact_evaluation::StartContactEvaluationOutput,
37        crate::operation::start_contact_evaluation::StartContactEvaluationError,
38    > for StartContactEvaluationFluentBuilder
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::start_contact_evaluation::StartContactEvaluationOutput,
46            crate::operation::start_contact_evaluation::StartContactEvaluationError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl StartContactEvaluationFluentBuilder {
53    /// Creates a new `StartContactEvaluationFluentBuilder`.
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 StartContactEvaluation as a reference.
62    pub fn as_input(&self) -> &crate::operation::start_contact_evaluation::builders::StartContactEvaluationInputBuilder {
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::start_contact_evaluation::StartContactEvaluationOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::start_contact_evaluation::StartContactEvaluationError,
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::start_contact_evaluation::StartContactEvaluation::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::start_contact_evaluation::StartContactEvaluation::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::start_contact_evaluation::StartContactEvaluationOutput,
99        crate::operation::start_contact_evaluation::StartContactEvaluationError,
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 identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
114    pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.instance_id(input.into());
116        self
117    }
118    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
119    pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_instance_id(input);
121        self
122    }
123    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
124    pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_instance_id()
126    }
127    /// <p>The identifier of the contact in this instance of Amazon Connect.</p>
128    pub fn contact_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.inner = self.inner.contact_id(input.into());
130        self
131    }
132    /// <p>The identifier of the contact in this instance of Amazon Connect.</p>
133    pub fn set_contact_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_contact_id(input);
135        self
136    }
137    /// <p>The identifier of the contact in this instance of Amazon Connect.</p>
138    pub fn get_contact_id(&self) -> &::std::option::Option<::std::string::String> {
139        self.inner.get_contact_id()
140    }
141    /// <p>The unique identifier for the evaluation form.</p>
142    pub fn evaluation_form_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.inner = self.inner.evaluation_form_id(input.into());
144        self
145    }
146    /// <p>The unique identifier for the evaluation form.</p>
147    pub fn set_evaluation_form_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.inner = self.inner.set_evaluation_form_id(input);
149        self
150    }
151    /// <p>The unique identifier for the evaluation form.</p>
152    pub fn get_evaluation_form_id(&self) -> &::std::option::Option<::std::string::String> {
153        self.inner.get_evaluation_form_id()
154    }
155    /// <p>Whether automated evaluations are enabled.</p>
156    pub fn auto_evaluation_configuration(mut self, input: crate::types::AutoEvaluationConfiguration) -> Self {
157        self.inner = self.inner.auto_evaluation_configuration(input);
158        self
159    }
160    /// <p>Whether automated evaluations are enabled.</p>
161    pub fn set_auto_evaluation_configuration(mut self, input: ::std::option::Option<crate::types::AutoEvaluationConfiguration>) -> Self {
162        self.inner = self.inner.set_auto_evaluation_configuration(input);
163        self
164    }
165    /// <p>Whether automated evaluations are enabled.</p>
166    pub fn get_auto_evaluation_configuration(&self) -> &::std::option::Option<crate::types::AutoEvaluationConfiguration> {
167        self.inner.get_auto_evaluation_configuration()
168    }
169    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
170    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
171        self.inner = self.inner.client_token(input.into());
172        self
173    }
174    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
175    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
176        self.inner = self.inner.set_client_token(input);
177        self
178    }
179    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
180    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
181        self.inner.get_client_token()
182    }
183    ///
184    /// Adds a key-value pair to `Tags`.
185    ///
186    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
187    ///
188    /// <p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>
189    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
190        self.inner = self.inner.tags(k.into(), v.into());
191        self
192    }
193    /// <p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>
194    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
195        self.inner = self.inner.set_tags(input);
196        self
197    }
198    /// <p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>
199    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
200        self.inner.get_tags()
201    }
202}
aws_sdk_connect/operation/start_contact_evaluation/builders.rs

aws_sdk_connect/operation/start_contact_evaluation/
builders.rs
