aws_sdk_evidently/operation/batch_evaluate_feature/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::batch_evaluate_feature::_batch_evaluate_feature_output::BatchEvaluateFeatureOutputBuilder;
3
4pub use crate::operation::batch_evaluate_feature::_batch_evaluate_feature_input::BatchEvaluateFeatureInputBuilder;
5
6impl crate::operation::batch_evaluate_feature::builders::BatchEvaluateFeatureInputBuilder {
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::batch_evaluate_feature::BatchEvaluateFeatureOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::batch_evaluate_feature::BatchEvaluateFeatureError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.batch_evaluate_feature();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `BatchEvaluateFeature`.
24///
25/// <p>This operation assigns feature variation to user sessions. For each user session, you pass in an <code>entityID</code> that represents the user. Evidently then checks the evaluation rules and assigns the variation.</p>
26/// <p>The first rules that are evaluated are the override rules. If the user's <code>entityID</code> matches an override rule, the user is served the variation specified by that rule.</p>
27/// <p>Next, if there is a launch of the feature, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch.</p>
28/// <p>If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment. If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment.</p>
29/// <p>If the user is not assigned to a launch or experiment, they are served the default variation.</p>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct BatchEvaluateFeatureFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::batch_evaluate_feature::builders::BatchEvaluateFeatureInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::batch_evaluate_feature::BatchEvaluateFeatureOutput,
39        crate::operation::batch_evaluate_feature::BatchEvaluateFeatureError,
40    > for BatchEvaluateFeatureFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::batch_evaluate_feature::BatchEvaluateFeatureOutput,
48            crate::operation::batch_evaluate_feature::BatchEvaluateFeatureError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl BatchEvaluateFeatureFluentBuilder {
55    /// Creates a new `BatchEvaluateFeatureFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the BatchEvaluateFeature as a reference.
64    pub fn as_input(&self) -> &crate::operation::batch_evaluate_feature::builders::BatchEvaluateFeatureInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::batch_evaluate_feature::BatchEvaluateFeatureOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::batch_evaluate_feature::BatchEvaluateFeatureError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::batch_evaluate_feature::BatchEvaluateFeature::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::batch_evaluate_feature::BatchEvaluateFeature::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::batch_evaluate_feature::BatchEvaluateFeatureOutput,
101        crate::operation::batch_evaluate_feature::BatchEvaluateFeatureError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <p>The name or ARN of the project that contains the feature being evaluated.</p>
116    pub fn project(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.inner = self.inner.project(input.into());
118        self
119    }
120    /// <p>The name or ARN of the project that contains the feature being evaluated.</p>
121    pub fn set_project(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_project(input);
123        self
124    }
125    /// <p>The name or ARN of the project that contains the feature being evaluated.</p>
126    pub fn get_project(&self) -> &::std::option::Option<::std::string::String> {
127        self.inner.get_project()
128    }
129    ///
130    /// Appends an item to `requests`.
131    ///
132    /// To override the contents of this collection use [`set_requests`](Self::set_requests).
133    ///
134    /// <p>An array of structures, where each structure assigns a feature variation to one user session.</p>
135    pub fn requests(mut self, input: crate::types::EvaluationRequest) -> Self {
136        self.inner = self.inner.requests(input);
137        self
138    }
139    /// <p>An array of structures, where each structure assigns a feature variation to one user session.</p>
140    pub fn set_requests(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::EvaluationRequest>>) -> Self {
141        self.inner = self.inner.set_requests(input);
142        self
143    }
144    /// <p>An array of structures, where each structure assigns a feature variation to one user session.</p>
145    pub fn get_requests(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::EvaluationRequest>> {
146        self.inner.get_requests()
147    }
148}