pub struct CreateWhatIfAnalysisFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateWhatIfAnalysis.
What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series.
For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals.
You could create a scenario where everything is given a 25% markdown, and another where everything is given a fixed dollar markdown. You could create a scenario where the sale lasts for one week and another where the sale lasts for one month. With a what-if analysis, you can compare many different scenarios against each other.
Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.
The TimeSeriesSelector object defines the items that you want in the what-if analysis.
Implementations§
Source§impl CreateWhatIfAnalysisFluentBuilder
impl CreateWhatIfAnalysisFluentBuilder
Sourcepub fn as_input(&self) -> &CreateWhatIfAnalysisInputBuilder
pub fn as_input(&self) -> &CreateWhatIfAnalysisInputBuilder
Access the CreateWhatIfAnalysis as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateWhatIfAnalysisOutput, SdkError<CreateWhatIfAnalysisError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateWhatIfAnalysisOutput, SdkError<CreateWhatIfAnalysisError, 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<CreateWhatIfAnalysisOutput, CreateWhatIfAnalysisError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateWhatIfAnalysisOutput, CreateWhatIfAnalysisError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn what_if_analysis_name(self, input: impl Into<String>) -> Self
pub fn what_if_analysis_name(self, input: impl Into<String>) -> Self
The name of the what-if analysis. Each name must be unique.
Sourcepub fn set_what_if_analysis_name(self, input: Option<String>) -> Self
pub fn set_what_if_analysis_name(self, input: Option<String>) -> Self
The name of the what-if analysis. Each name must be unique.
Sourcepub fn get_what_if_analysis_name(&self) -> &Option<String>
pub fn get_what_if_analysis_name(&self) -> &Option<String>
The name of the what-if analysis. Each name must be unique.
Sourcepub fn forecast_arn(self, input: impl Into<String>) -> Self
pub fn forecast_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the baseline forecast.
Sourcepub fn set_forecast_arn(self, input: Option<String>) -> Self
pub fn set_forecast_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the baseline forecast.
Sourcepub fn get_forecast_arn(&self) -> &Option<String>
pub fn get_forecast_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the baseline forecast.
Sourcepub fn time_series_selector(self, input: TimeSeriesSelector) -> Self
pub fn time_series_selector(self, input: TimeSeriesSelector) -> Self
Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.
The TimeSeriesIdentifiers object needs the following information:
-
DataSource -
Format -
Schema
Sourcepub fn set_time_series_selector(self, input: Option<TimeSeriesSelector>) -> Self
pub fn set_time_series_selector(self, input: Option<TimeSeriesSelector>) -> Self
Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.
The TimeSeriesIdentifiers object needs the following information:
-
DataSource -
Format -
Schema
Sourcepub fn get_time_series_selector(&self) -> &Option<TimeSeriesSelector>
pub fn get_time_series_selector(&self) -> &Option<TimeSeriesSelector>
Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.
The TimeSeriesIdentifiers object needs the following information:
-
DataSource -
Format -
Schema
A list of tags to apply to the what if forecast.
A list of tags to apply to the what if forecast.
Trait Implementations§
Source§impl Clone for CreateWhatIfAnalysisFluentBuilder
impl Clone for CreateWhatIfAnalysisFluentBuilder
Source§fn clone(&self) -> CreateWhatIfAnalysisFluentBuilder
fn clone(&self) -> CreateWhatIfAnalysisFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateWhatIfAnalysisFluentBuilder
impl !RefUnwindSafe for CreateWhatIfAnalysisFluentBuilder
impl Send for CreateWhatIfAnalysisFluentBuilder
impl Sync for CreateWhatIfAnalysisFluentBuilder
impl Unpin for CreateWhatIfAnalysisFluentBuilder
impl !UnwindSafe for CreateWhatIfAnalysisFluentBuilder
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);