pub struct EvaluateFeatureFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to EvaluateFeature
.
This operation assigns a feature variation to one given user session. You pass in an entityID
that represents the user. Evidently then checks the evaluation rules and assigns the variation.
The first rules that are evaluated are the override rules. If the user's entityID
matches an override rule, the user is served the variation specified by that rule.
If there is a current launch with this feature that uses segment overrides, and if the user session's evaluationContext
matches a segment rule defined in a segment override, the configuration in the segment overrides is used. For more information about segments, see CreateSegment and Use segments to focus your audience.
If there is a launch with no segment overrides, 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.
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 experiment uses a segment, then only user sessions with evaluationContext
values that match the segment rule are used in the 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.
If the user is not assigned to a launch or experiment, they are served the default variation.
Implementations§
Source§impl EvaluateFeatureFluentBuilder
impl EvaluateFeatureFluentBuilder
Sourcepub fn as_input(&self) -> &EvaluateFeatureInputBuilder
pub fn as_input(&self) -> &EvaluateFeatureInputBuilder
Access the EvaluateFeature as a reference.
Sourcepub async fn send(
self,
) -> Result<EvaluateFeatureOutput, SdkError<EvaluateFeatureError, HttpResponse>>
pub async fn send( self, ) -> Result<EvaluateFeatureOutput, SdkError<EvaluateFeatureError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<EvaluateFeatureOutput, EvaluateFeatureError, Self>
pub fn customize( self, ) -> CustomizableOperation<EvaluateFeatureOutput, EvaluateFeatureError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn project(self, input: impl Into<String>) -> Self
pub fn project(self, input: impl Into<String>) -> Self
The name or ARN of the project that contains this feature.
Sourcepub fn set_project(self, input: Option<String>) -> Self
pub fn set_project(self, input: Option<String>) -> Self
The name or ARN of the project that contains this feature.
Sourcepub fn get_project(&self) -> &Option<String>
pub fn get_project(&self) -> &Option<String>
The name or ARN of the project that contains this feature.
Sourcepub fn feature(self, input: impl Into<String>) -> Self
pub fn feature(self, input: impl Into<String>) -> Self
The name of the feature being evaluated.
Sourcepub fn set_feature(self, input: Option<String>) -> Self
pub fn set_feature(self, input: Option<String>) -> Self
The name of the feature being evaluated.
Sourcepub fn get_feature(&self) -> &Option<String>
pub fn get_feature(&self) -> &Option<String>
The name of the feature being evaluated.
Sourcepub fn entity_id(self, input: impl Into<String>) -> Self
pub fn entity_id(self, input: impl Into<String>) -> Self
An internal ID that represents a unique user of the application. This entityID
is checked against any override rules assigned for this feature.
Sourcepub fn set_entity_id(self, input: Option<String>) -> Self
pub fn set_entity_id(self, input: Option<String>) -> Self
An internal ID that represents a unique user of the application. This entityID
is checked against any override rules assigned for this feature.
Sourcepub fn get_entity_id(&self) -> &Option<String>
pub fn get_entity_id(&self) -> &Option<String>
An internal ID that represents a unique user of the application. This entityID
is checked against any override rules assigned for this feature.
Sourcepub fn evaluation_context(self, input: impl Into<String>) -> Self
pub fn evaluation_context(self, input: impl Into<String>) -> Self
A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience.
If you include this parameter, the value must be a JSON object. A JSON array is not supported.
Sourcepub fn set_evaluation_context(self, input: Option<String>) -> Self
pub fn set_evaluation_context(self, input: Option<String>) -> Self
A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience.
If you include this parameter, the value must be a JSON object. A JSON array is not supported.
Sourcepub fn get_evaluation_context(&self) -> &Option<String>
pub fn get_evaluation_context(&self) -> &Option<String>
A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience.
If you include this parameter, the value must be a JSON object. A JSON array is not supported.
Trait Implementations§
Source§impl Clone for EvaluateFeatureFluentBuilder
impl Clone for EvaluateFeatureFluentBuilder
Source§fn clone(&self) -> EvaluateFeatureFluentBuilder
fn clone(&self) -> EvaluateFeatureFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for EvaluateFeatureFluentBuilder
impl !RefUnwindSafe for EvaluateFeatureFluentBuilder
impl Send for EvaluateFeatureFluentBuilder
impl Sync for EvaluateFeatureFluentBuilder
impl Unpin for EvaluateFeatureFluentBuilder
impl !UnwindSafe for EvaluateFeatureFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);