aws_sdk_forecast::operation::describe_predictor::builders

Struct DescribePredictorOutputBuilder

#[non_exhaustive]
pub struct DescribePredictorOutputBuilder { /* private fields */ }

Expand description

A builder for DescribePredictorOutput.

Implementations§

Source §

impl DescribePredictorOutputBuilder

Source

pub fn predictor_arn(self, input: impl Into<String>) -> Self

The ARN of the predictor.

Source

pub fn set_predictor_arn(self, input: Option<String>) -> Self

The ARN of the predictor.

Source

pub fn get_predictor_arn(&self) -> &Option<String>

The ARN of the predictor.

Source

pub fn predictor_name(self, input: impl Into<String>) -> Self

The name of the predictor.

Source

pub fn set_predictor_name(self, input: Option<String>) -> Self

The name of the predictor.

Source

pub fn get_predictor_name(&self) -> &Option<String>

The name of the predictor.

Source

pub fn algorithm_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the algorithm used for model training.

Source

pub fn set_algorithm_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the algorithm used for model training.

Source

pub fn get_algorithm_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the algorithm used for model training.

Source

pub fn auto_ml_algorithm_arns(self, input: impl Into<String>) -> Self

Appends an item to auto_ml_algorithm_arns.

To override the contents of this collection use set_auto_ml_algorithm_arns.

When PerformAutoML is specified, the ARN of the chosen algorithm.

Source

pub fn set_auto_ml_algorithm_arns(self, input: Option<Vec<String>>) -> Self

When PerformAutoML is specified, the ARN of the chosen algorithm.

Source

pub fn get_auto_ml_algorithm_arns(&self) -> &Option<Vec<String>>

When PerformAutoML is specified, the ARN of the chosen algorithm.

Source

pub fn forecast_horizon(self, input: i32) -> Self

The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

Source

pub fn set_forecast_horizon(self, input: Option<i32>) -> Self

The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

Source

pub fn get_forecast_horizon(&self) -> &Option<i32>

The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

Source

pub fn forecast_types(self, input: impl Into<String>) -> Self

Appends an item to forecast_types.

To override the contents of this collection use set_forecast_types.

The forecast types used during predictor training. Default value is \["0.1","0.5","0.9"\]

Source

pub fn set_forecast_types(self, input: Option<Vec<String>>) -> Self

The forecast types used during predictor training. Default value is \["0.1","0.5","0.9"\]

Source

pub fn get_forecast_types(&self) -> &Option<Vec<String>>

The forecast types used during predictor training. Default value is \["0.1","0.5","0.9"\]

Source

pub fn perform_auto_ml(self, input: bool) -> Self

Whether the predictor is set to perform AutoML.

Source

pub fn set_perform_auto_ml(self, input: Option<bool>) -> Self

Whether the predictor is set to perform AutoML.

Source

pub fn get_perform_auto_ml(&self) -> &Option<bool>

Whether the predictor is set to perform AutoML.

Source

pub fn auto_ml_override_strategy(self, input: AutoMlOverrideStrategy) -> Self

The LatencyOptimized AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.

The AutoML strategy used to train the predictor. Unless LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy.

This parameter is only valid for predictors trained using AutoML.

Source

pub fn set_auto_ml_override_strategy( self, input: Option<AutoMlOverrideStrategy>, ) -> Self

The LatencyOptimized AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.

The AutoML strategy used to train the predictor. Unless LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy.

This parameter is only valid for predictors trained using AutoML.

Source

pub fn get_auto_ml_override_strategy(&self) -> &Option<AutoMlOverrideStrategy>

The LatencyOptimized AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.

The AutoML strategy used to train the predictor. Unless LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy.

This parameter is only valid for predictors trained using AutoML.

Source

pub fn perform_hpo(self, input: bool) -> Self

Whether the predictor is set to perform hyperparameter optimization (HPO).

Source

pub fn set_perform_hpo(self, input: Option<bool>) -> Self

Whether the predictor is set to perform hyperparameter optimization (HPO).

Source

pub fn get_perform_hpo(&self) -> &Option<bool>

Whether the predictor is set to perform hyperparameter optimization (HPO).

Source

pub fn training_parameters( self, k: impl Into<String>, v: impl Into<String>, ) -> Self

Adds a key-value pair to training_parameters.

To override the contents of this collection use set_training_parameters.

The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

Source

pub fn set_training_parameters( self, input: Option<HashMap<String, String>>, ) -> Self

The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

Source

pub fn get_training_parameters(&self) -> &Option<HashMap<String, String>>

The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

Source

pub fn evaluation_parameters(self, input: EvaluationParameters) -> Self

Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.

Source

pub fn set_evaluation_parameters( self, input: Option<EvaluationParameters>, ) -> Self

Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.

Source

pub fn get_evaluation_parameters(&self) -> &Option<EvaluationParameters>

Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.

Source

pub fn hpo_config(self, input: HyperParameterTuningJobConfig) -> Self

The hyperparameter override values for the algorithm.

Source

pub fn set_hpo_config( self, input: Option<HyperParameterTuningJobConfig>, ) -> Self

The hyperparameter override values for the algorithm.

Source

pub fn get_hpo_config(&self) -> &Option<HyperParameterTuningJobConfig>

The hyperparameter override values for the algorithm.

Source

pub fn input_data_config(self, input: InputDataConfig) -> Self

Describes the dataset group that contains the data to use to train the predictor.

Source

pub fn set_input_data_config(self, input: Option<InputDataConfig>) -> Self

Describes the dataset group that contains the data to use to train the predictor.

Source

pub fn get_input_data_config(&self) -> &Option<InputDataConfig>

Describes the dataset group that contains the data to use to train the predictor.

Source

pub fn featurization_config(self, input: FeaturizationConfig) -> Self

The featurization configuration.

Source

pub fn set_featurization_config( self, input: Option<FeaturizationConfig>, ) -> Self

The featurization configuration.

Source

pub fn get_featurization_config(&self) -> &Option<FeaturizationConfig>

The featurization configuration.

Source

pub fn encryption_config(self, input: EncryptionConfig) -> Self

An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

Source

pub fn set_encryption_config(self, input: Option<EncryptionConfig>) -> Self

An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

Source

pub fn get_encryption_config(&self) -> &Option<EncryptionConfig>

An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

Source

pub fn predictor_execution_details( self, input: PredictorExecutionDetails, ) -> Self

Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.

Source

pub fn set_predictor_execution_details( self, input: Option<PredictorExecutionDetails>, ) -> Self

Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.

Source

pub fn get_predictor_execution_details( &self, ) -> &Option<PredictorExecutionDetails>

Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.

Source

pub fn estimated_time_remaining_in_minutes(self, input: i64) -> Self

The estimated time remaining in minutes for the predictor training job to complete.

Source

pub fn set_estimated_time_remaining_in_minutes(self, input: Option<i64>) -> Self

The estimated time remaining in minutes for the predictor training job to complete.

Source

pub fn get_estimated_time_remaining_in_minutes(&self) -> &Option<i64>

The estimated time remaining in minutes for the predictor training job to complete.

Source

pub fn is_auto_predictor(self, input: bool) -> Self

Whether the predictor was created with CreateAutoPredictor.

Source

pub fn set_is_auto_predictor(self, input: Option<bool>) -> Self

Whether the predictor was created with CreateAutoPredictor.

Source

pub fn get_is_auto_predictor(&self) -> &Option<bool>

Whether the predictor was created with CreateAutoPredictor.

Source

pub fn dataset_import_job_arns(self, input: impl Into<String>) -> Self

Appends an item to dataset_import_job_arns.

To override the contents of this collection use set_dataset_import_job_arns.

An array of the ARNs of the dataset import jobs used to import training data for the predictor.

Source

pub fn set_dataset_import_job_arns(self, input: Option<Vec<String>>) -> Self

An array of the ARNs of the dataset import jobs used to import training data for the predictor.

Source

pub fn get_dataset_import_job_arns(&self) -> &Option<Vec<String>>

An array of the ARNs of the dataset import jobs used to import training data for the predictor.

Source

pub fn status(self, input: impl Into<String>) -> Self

The status of the predictor. States include:

ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Source

pub fn set_status(self, input: Option<String>) -> Self

The status of the predictor. States include:

ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Source

pub fn get_status(&self) -> &Option<String>

The status of the predictor. States include:

ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Source

pub fn message(self, input: impl Into<String>) -> Self

If an error occurred, an informational message about the error.

Source

pub fn set_message(self, input: Option<String>) -> Self

If an error occurred, an informational message about the error.

Source

pub fn get_message(&self) -> &Option<String>

If an error occurred, an informational message about the error.

Source

pub fn creation_time(self, input: DateTime) -> Self

When the model training task was created.

Source

pub fn set_creation_time(self, input: Option<DateTime>) -> Self

When the model training task was created.

Source

pub fn get_creation_time(&self) -> &Option<DateTime>

When the model training task was created.

Source

pub fn last_modification_time(self, input: DateTime) -> Self

The last time the resource was modified. The timestamp depends on the status of the job:

CREATE_PENDING - The CreationTime.
CREATE_IN_PROGRESS - The current timestamp.
CREATE_STOPPING - The current timestamp.
CREATE_STOPPED - When the job stopped.
ACTIVE or CREATE_FAILED - When the job finished or failed.

Source

pub fn set_last_modification_time(self, input: Option<DateTime>) -> Self

The last time the resource was modified. The timestamp depends on the status of the job:

CREATE_PENDING - The CreationTime.
CREATE_IN_PROGRESS - The current timestamp.
CREATE_STOPPING - The current timestamp.
CREATE_STOPPED - When the job stopped.
ACTIVE or CREATE_FAILED - When the job finished or failed.

Source

pub fn get_last_modification_time(&self) -> &Option<DateTime>

The last time the resource was modified. The timestamp depends on the status of the job:

CREATE_PENDING - The CreationTime.
CREATE_IN_PROGRESS - The current timestamp.
CREATE_STOPPING - The current timestamp.
CREATE_STOPPED - When the job stopped.
ACTIVE or CREATE_FAILED - When the job finished or failed.

Source

pub fn optimization_metric(self, input: OptimizationMetric) -> Self

The accuracy metric used to optimize the predictor.

Source

pub fn set_optimization_metric(self, input: Option<OptimizationMetric>) -> Self

The accuracy metric used to optimize the predictor.

Source

pub fn get_optimization_metric(&self) -> &Option<OptimizationMetric>

The accuracy metric used to optimize the predictor.

Source

pub fn build(self) -> DescribePredictorOutput

Consumes the builder and constructs a DescribePredictorOutput.

Trait Implementations§

Source §

impl Clone for DescribePredictorOutputBuilder

Source §

fn clone(&self) -> DescribePredictorOutputBuilder

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Source §

impl Debug for DescribePredictorOutputBuilder

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Source §

impl Default for DescribePredictorOutputBuilder

Source §

fn default() -> DescribePredictorOutputBuilder

Returns the “default value” for a type. Read more

Source §

impl PartialEq for DescribePredictorOutputBuilder

Source §

fn eq(&self, other: &DescribePredictorOutputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Source §

impl StructuralPartialEq for DescribePredictorOutputBuilder

Auto Trait Implementations§

§

impl UnwindSafe for DescribePredictorOutputBuilder

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more

Source §

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source §

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

Source §

impl<T> Paint for T
where T: ?Sized,

Source §

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example

println!("{}", value.primary());

Source §

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example

println!("{}", value.fixed(color));

Source §

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example

println!("{}", value.rgb(r, g, b));

Source §

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example

println!("{}", value.black());

Source §

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example

println!("{}", value.red());

Source §

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example

println!("{}", value.green());

Source §

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example

println!("{}", value.yellow());

Source §

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example

println!("{}", value.blue());

Source §

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example

println!("{}", value.magenta());

Source §

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example

println!("{}", value.cyan());

Source §

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example

println!("{}", value.white());

Source §

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example

println!("{}", value.bright_black());

Source §

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example

println!("{}", value.bright_red());

Source §

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example

println!("{}", value.bright_green());

Source §

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example

println!("{}", value.bright_yellow());

Source §

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example

println!("{}", value.bright_blue());

Source §

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example

println!("{}", value.bright_magenta());

Source §

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example

println!("{}", value.bright_cyan());

Source §

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example

println!("{}", value.bright_white());

Source §

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>

Returns self with the bg() set to [Color :: Primary].

§Example

println!("{}", value.on_primary());

Source §

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example

println!("{}", value.on_fixed(color));

Source §

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example

println!("{}", value.on_rgb(r, g, b));

Source §

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example

println!("{}", value.on_black());

Source §

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example

println!("{}", value.on_red());

Source §

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example

println!("{}", value.on_green());

Source §

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example

println!("{}", value.on_yellow());

Source §

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example

println!("{}", value.on_blue());

Source §

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example

println!("{}", value.on_magenta());

Source §

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example

println!("{}", value.on_cyan());

Source §

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example

println!("{}", value.on_white());

Source §

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example

println!("{}", value.on_bright_black());

Source §

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example

println!("{}", value.on_bright_red());

Source §

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example

println!("{}", value.on_bright_green());

Source §

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example

println!("{}", value.on_bright_yellow());

Source §

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example

println!("{}", value.on_bright_blue());

Source §

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example

println!("{}", value.on_bright_magenta());

Source §

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example

println!("{}", value.on_bright_cyan());

Source §

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example

println!("{}", value.on_bright_white());

Source §

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example

println!("{}", value.bold());

Source §

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example

println!("{}", value.dim());

Source §

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example

println!("{}", value.italic());

Source §

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example

println!("{}", value.underline());

Source §

fn blink(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Blink].

§Example

println!("{}", value.blink());

Source §

fn rapid_blink(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example

println!("{}", value.rapid_blink());

Source §

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example

println!("{}", value.invert());

Source §

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example

println!("{}", value.conceal());

Source §

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example

println!("{}", value.strike());

Source §

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example

println!("{}", value.mask());

Source §

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example

println!("{}", value.wrap());

Source §

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example

println!("{}", value.linger());

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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example

println!("{}", value.clear());

Source §

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example

println!("{}", value.resetting());

Source §

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example

println!("{}", value.bright());

Source §

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example

println!("{}", value.on_bright());

Source §

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);

Source §

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more

Source §

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more

Source §

impl<T> Same for T

Source §

type Output = T

Should always be Self

Source §

impl<T> ToOwned for T
where T: Clone,

Source §

type Owned = T

The resulting type after obtaining ownership.

Source §

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

Source §

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

Source §

impl<T, U> TryFrom for T
where U: Into<T>,

Source §

type Error = Infallible

The type returned in the event of a conversion error.

Source §

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

impl<T> WithSubscriber for T

Source §

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Source §

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Source §

DescribePredictorOutputBuilder

Struct DescribePredictorOutputBuilder Copy item path

Implementations§

impl DescribePredictorOutputBuilder

pub fn predictor_arn(self, input: impl Into<String>) -> Self

pub fn set_predictor_arn(self, input: Option<String>) -> Self

pub fn get_predictor_arn(&self) -> &Option<String>

pub fn predictor_name(self, input: impl Into<String>) -> Self

pub fn set_predictor_name(self, input: Option<String>) -> Self

pub fn get_predictor_name(&self) -> &Option<String>

pub fn algorithm_arn(self, input: impl Into<String>) -> Self

pub fn set_algorithm_arn(self, input: Option<String>) -> Self

pub fn get_algorithm_arn(&self) -> &Option<String>

pub fn auto_ml_algorithm_arns(self, input: impl Into<String>) -> Self

pub fn set_auto_ml_algorithm_arns(self, input: Option<Vec<String>>) -> Self

pub fn get_auto_ml_algorithm_arns(&self) -> &Option<Vec<String>>

pub fn forecast_horizon(self, input: i32) -> Self

pub fn set_forecast_horizon(self, input: Option<i32>) -> Self

pub fn get_forecast_horizon(&self) -> &Option<i32>

pub fn forecast_types(self, input: impl Into<String>) -> Self

pub fn set_forecast_types(self, input: Option<Vec<String>>) -> Self

pub fn get_forecast_types(&self) -> &Option<Vec<String>>

pub fn perform_auto_ml(self, input: bool) -> Self

pub fn set_perform_auto_ml(self, input: Option<bool>) -> Self

pub fn get_perform_auto_ml(&self) -> &Option<bool>

pub fn auto_ml_override_strategy(self, input: AutoMlOverrideStrategy) -> Self

pub fn set_auto_ml_override_strategy( self, input: Option<AutoMlOverrideStrategy>, ) -> Self

pub fn get_auto_ml_override_strategy(&self) -> &Option<AutoMlOverrideStrategy>

pub fn perform_hpo(self, input: bool) -> Self

pub fn set_perform_hpo(self, input: Option<bool>) -> Self

pub fn get_perform_hpo(&self) -> &Option<bool>

pub fn training_parameters( self, k: impl Into<String>, v: impl Into<String>, ) -> Self

pub fn set_training_parameters( self, input: Option<HashMap<String, String>>, ) -> Self

pub fn get_training_parameters(&self) -> &Option<HashMap<String, String>>

pub fn evaluation_parameters(self, input: EvaluationParameters) -> Self

pub fn set_evaluation_parameters( self, input: Option<EvaluationParameters>, ) -> Self

pub fn get_evaluation_parameters(&self) -> &Option<EvaluationParameters>

pub fn hpo_config(self, input: HyperParameterTuningJobConfig) -> Self

pub fn set_hpo_config( self, input: Option<HyperParameterTuningJobConfig>, ) -> Self

pub fn get_hpo_config(&self) -> &Option<HyperParameterTuningJobConfig>

pub fn input_data_config(self, input: InputDataConfig) -> Self

pub fn set_input_data_config(self, input: Option<InputDataConfig>) -> Self

pub fn get_input_data_config(&self) -> &Option<InputDataConfig>

pub fn featurization_config(self, input: FeaturizationConfig) -> Self

pub fn set_featurization_config( self, input: Option<FeaturizationConfig>, ) -> Self

pub fn get_featurization_config(&self) -> &Option<FeaturizationConfig>

pub fn encryption_config(self, input: EncryptionConfig) -> Self

pub fn set_encryption_config(self, input: Option<EncryptionConfig>) -> Self

pub fn get_encryption_config(&self) -> &Option<EncryptionConfig>

pub fn predictor_execution_details( self, input: PredictorExecutionDetails, ) -> Self

pub fn set_predictor_execution_details( self, input: Option<PredictorExecutionDetails>, ) -> Self

pub fn get_predictor_execution_details( &self, ) -> &Option<PredictorExecutionDetails>

pub fn estimated_time_remaining_in_minutes(self, input: i64) -> Self

pub fn set_estimated_time_remaining_in_minutes(self, input: Option<i64>) -> Self

pub fn get_estimated_time_remaining_in_minutes(&self) -> &Option<i64>

pub fn is_auto_predictor(self, input: bool) -> Self

pub fn set_is_auto_predictor(self, input: Option<bool>) -> Self

pub fn get_is_auto_predictor(&self) -> &Option<bool>

pub fn dataset_import_job_arns(self, input: impl Into<String>) -> Self

pub fn set_dataset_import_job_arns(self, input: Option<Vec<String>>) -> Self

pub fn get_dataset_import_job_arns(&self) -> &Option<Vec<String>>

pub fn status(self, input: impl Into<String>) -> Self

pub fn set_status(self, input: Option<String>) -> Self

pub fn get_status(&self) -> &Option<String>

pub fn message(self, input: impl Into<String>) -> Self

pub fn set_message(self, input: Option<String>) -> Self

pub fn get_message(&self) -> &Option<String>

pub fn creation_time(self, input: DateTime) -> Self

pub fn set_creation_time(self, input: Option<DateTime>) -> Self

pub fn get_creation_time(&self) -> &Option<DateTime>

pub fn last_modification_time(self, input: DateTime) -> Self

pub fn set_last_modification_time(self, input: Option<DateTime>) -> Self

pub fn get_last_modification_time(&self) -> &Option<DateTime>

pub fn optimization_metric(self, input: OptimizationMetric) -> Self

pub fn set_optimization_metric(self, input: Option<OptimizationMetric>) -> Self

pub fn get_optimization_metric(&self) -> &Option<OptimizationMetric>

pub fn build(self) -> DescribePredictorOutput

Trait Implementations§

impl Clone for DescribePredictorOutputBuilder

fn clone(&self) -> DescribePredictorOutputBuilder

Struct DescribePredictorOutputBuilder

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> Paint for T
where T: ?Sized,