#[non_exhaustive]pub struct DescribeInferenceExperimentOutputBuilder { /* private fields */ }
Expand description
A builder for DescribeInferenceExperimentOutput
.
Implementations§
Source§impl DescribeInferenceExperimentOutputBuilder
impl DescribeInferenceExperimentOutputBuilder
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The ARN of the inference experiment being described.
This field is required.Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The ARN of the inference experiment being described.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the inference experiment.
This field is required.Sourcepub fn type(self, input: InferenceExperimentType) -> Self
pub fn type(self, input: InferenceExperimentType) -> Self
The type of the inference experiment.
This field is required.Sourcepub fn set_type(self, input: Option<InferenceExperimentType>) -> Self
pub fn set_type(self, input: Option<InferenceExperimentType>) -> Self
The type of the inference experiment.
Sourcepub fn get_type(&self) -> &Option<InferenceExperimentType>
pub fn get_type(&self) -> &Option<InferenceExperimentType>
The type of the inference experiment.
Sourcepub fn schedule(self, input: InferenceExperimentSchedule) -> Self
pub fn schedule(self, input: InferenceExperimentSchedule) -> Self
The duration for which the inference experiment ran or will run.
Sourcepub fn set_schedule(self, input: Option<InferenceExperimentSchedule>) -> Self
pub fn set_schedule(self, input: Option<InferenceExperimentSchedule>) -> Self
The duration for which the inference experiment ran or will run.
Sourcepub fn get_schedule(&self) -> &Option<InferenceExperimentSchedule>
pub fn get_schedule(&self) -> &Option<InferenceExperimentSchedule>
The duration for which the inference experiment ran or will run.
Sourcepub fn status(self, input: InferenceExperimentStatus) -> Self
pub fn status(self, input: InferenceExperimentStatus) -> Self
The status of the inference experiment. The following are the possible statuses for an inference experiment:
-
Creating
- Amazon SageMaker is creating your experiment. -
Created
- Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time. -
Updating
- When you make changes to your experiment, your experiment shows as updating. -
Starting
- Amazon SageMaker is beginning your experiment. -
Running
- Your experiment is in progress. -
Stopping
- Amazon SageMaker is stopping your experiment. -
Completed
- Your experiment has completed. -
Cancelled
- When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.
Sourcepub fn set_status(self, input: Option<InferenceExperimentStatus>) -> Self
pub fn set_status(self, input: Option<InferenceExperimentStatus>) -> Self
The status of the inference experiment. The following are the possible statuses for an inference experiment:
-
Creating
- Amazon SageMaker is creating your experiment. -
Created
- Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time. -
Updating
- When you make changes to your experiment, your experiment shows as updating. -
Starting
- Amazon SageMaker is beginning your experiment. -
Running
- Your experiment is in progress. -
Stopping
- Amazon SageMaker is stopping your experiment. -
Completed
- Your experiment has completed. -
Cancelled
- When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.
Sourcepub fn get_status(&self) -> &Option<InferenceExperimentStatus>
pub fn get_status(&self) -> &Option<InferenceExperimentStatus>
The status of the inference experiment. The following are the possible statuses for an inference experiment:
-
Creating
- Amazon SageMaker is creating your experiment. -
Created
- Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time. -
Updating
- When you make changes to your experiment, your experiment shows as updating. -
Starting
- Amazon SageMaker is beginning your experiment. -
Running
- Your experiment is in progress. -
Stopping
- Amazon SageMaker is stopping your experiment. -
Completed
- Your experiment has completed. -
Cancelled
- When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.
Sourcepub fn status_reason(self, input: impl Into<String>) -> Self
pub fn status_reason(self, input: impl Into<String>) -> Self
The error message or client-specified Reason
from the StopInferenceExperiment API, that explains the status of the inference experiment.
Sourcepub fn set_status_reason(self, input: Option<String>) -> Self
pub fn set_status_reason(self, input: Option<String>) -> Self
The error message or client-specified Reason
from the StopInferenceExperiment API, that explains the status of the inference experiment.
Sourcepub fn get_status_reason(&self) -> &Option<String>
pub fn get_status_reason(&self) -> &Option<String>
The error message or client-specified Reason
from the StopInferenceExperiment API, that explains the status of the inference experiment.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the inference experiment.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the inference experiment.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the inference experiment.
Sourcepub fn creation_time(self, input: DateTime) -> Self
pub fn creation_time(self, input: DateTime) -> Self
The timestamp at which you created the inference experiment.
Sourcepub fn set_creation_time(self, input: Option<DateTime>) -> Self
pub fn set_creation_time(self, input: Option<DateTime>) -> Self
The timestamp at which you created the inference experiment.
Sourcepub fn get_creation_time(&self) -> &Option<DateTime>
pub fn get_creation_time(&self) -> &Option<DateTime>
The timestamp at which you created the inference experiment.
Sourcepub fn completion_time(self, input: DateTime) -> Self
pub fn completion_time(self, input: DateTime) -> Self
The timestamp at which the inference experiment was completed.
Sourcepub fn set_completion_time(self, input: Option<DateTime>) -> Self
pub fn set_completion_time(self, input: Option<DateTime>) -> Self
The timestamp at which the inference experiment was completed.
Sourcepub fn get_completion_time(&self) -> &Option<DateTime>
pub fn get_completion_time(&self) -> &Option<DateTime>
The timestamp at which the inference experiment was completed.
Sourcepub fn last_modified_time(self, input: DateTime) -> Self
pub fn last_modified_time(self, input: DateTime) -> Self
The timestamp at which you last modified the inference experiment.
Sourcepub fn set_last_modified_time(self, input: Option<DateTime>) -> Self
pub fn set_last_modified_time(self, input: Option<DateTime>) -> Self
The timestamp at which you last modified the inference experiment.
Sourcepub fn get_last_modified_time(&self) -> &Option<DateTime>
pub fn get_last_modified_time(&self) -> &Option<DateTime>
The timestamp at which you last modified the inference experiment.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
Sourcepub fn endpoint_metadata(self, input: EndpointMetadata) -> Self
pub fn endpoint_metadata(self, input: EndpointMetadata) -> Self
The metadata of the endpoint on which the inference experiment ran.
This field is required.Sourcepub fn set_endpoint_metadata(self, input: Option<EndpointMetadata>) -> Self
pub fn set_endpoint_metadata(self, input: Option<EndpointMetadata>) -> Self
The metadata of the endpoint on which the inference experiment ran.
Sourcepub fn get_endpoint_metadata(&self) -> &Option<EndpointMetadata>
pub fn get_endpoint_metadata(&self) -> &Option<EndpointMetadata>
The metadata of the endpoint on which the inference experiment ran.
Sourcepub fn model_variants(self, input: ModelVariantConfigSummary) -> Self
pub fn model_variants(self, input: ModelVariantConfigSummary) -> Self
Appends an item to model_variants
.
To override the contents of this collection use set_model_variants
.
An array of ModelVariantConfigSummary
objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary
object in the array describes the infrastructure configuration for deploying the corresponding variant.
Sourcepub fn set_model_variants(
self,
input: Option<Vec<ModelVariantConfigSummary>>,
) -> Self
pub fn set_model_variants( self, input: Option<Vec<ModelVariantConfigSummary>>, ) -> Self
An array of ModelVariantConfigSummary
objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary
object in the array describes the infrastructure configuration for deploying the corresponding variant.
Sourcepub fn get_model_variants(&self) -> &Option<Vec<ModelVariantConfigSummary>>
pub fn get_model_variants(&self) -> &Option<Vec<ModelVariantConfigSummary>>
An array of ModelVariantConfigSummary
objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary
object in the array describes the infrastructure configuration for deploying the corresponding variant.
Sourcepub fn data_storage_config(
self,
input: InferenceExperimentDataStorageConfig,
) -> Self
pub fn data_storage_config( self, input: InferenceExperimentDataStorageConfig, ) -> Self
The Amazon S3 location and configuration for storing inference request and response data.
Sourcepub fn set_data_storage_config(
self,
input: Option<InferenceExperimentDataStorageConfig>,
) -> Self
pub fn set_data_storage_config( self, input: Option<InferenceExperimentDataStorageConfig>, ) -> Self
The Amazon S3 location and configuration for storing inference request and response data.
Sourcepub fn get_data_storage_config(
&self,
) -> &Option<InferenceExperimentDataStorageConfig>
pub fn get_data_storage_config( &self, ) -> &Option<InferenceExperimentDataStorageConfig>
The Amazon S3 location and configuration for storing inference request and response data.
Sourcepub fn shadow_mode_config(self, input: ShadowModeConfig) -> Self
pub fn shadow_mode_config(self, input: ShadowModeConfig) -> Self
The configuration of ShadowMode
inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.
Sourcepub fn set_shadow_mode_config(self, input: Option<ShadowModeConfig>) -> Self
pub fn set_shadow_mode_config(self, input: Option<ShadowModeConfig>) -> Self
The configuration of ShadowMode
inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.
Sourcepub fn get_shadow_mode_config(&self) -> &Option<ShadowModeConfig>
pub fn get_shadow_mode_config(&self) -> &Option<ShadowModeConfig>
The configuration of ShadowMode
inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.
Sourcepub fn kms_key(self, input: impl Into<String>) -> Self
pub fn kms_key(self, input: impl Into<String>) -> Self
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.
Sourcepub fn set_kms_key(self, input: Option<String>) -> Self
pub fn set_kms_key(self, input: Option<String>) -> Self
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.
Sourcepub fn get_kms_key(&self) -> &Option<String>
pub fn get_kms_key(&self) -> &Option<String>
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.
Sourcepub fn build(self) -> DescribeInferenceExperimentOutput
pub fn build(self) -> DescribeInferenceExperimentOutput
Consumes the builder and constructs a DescribeInferenceExperimentOutput
.
Trait Implementations§
Source§impl Clone for DescribeInferenceExperimentOutputBuilder
impl Clone for DescribeInferenceExperimentOutputBuilder
Source§fn clone(&self) -> DescribeInferenceExperimentOutputBuilder
fn clone(&self) -> DescribeInferenceExperimentOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for DescribeInferenceExperimentOutputBuilder
impl Default for DescribeInferenceExperimentOutputBuilder
Source§fn default() -> DescribeInferenceExperimentOutputBuilder
fn default() -> DescribeInferenceExperimentOutputBuilder
Source§impl PartialEq for DescribeInferenceExperimentOutputBuilder
impl PartialEq for DescribeInferenceExperimentOutputBuilder
Source§fn eq(&self, other: &DescribeInferenceExperimentOutputBuilder) -> bool
fn eq(&self, other: &DescribeInferenceExperimentOutputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for DescribeInferenceExperimentOutputBuilder
Auto Trait Implementations§
impl Freeze for DescribeInferenceExperimentOutputBuilder
impl RefUnwindSafe for DescribeInferenceExperimentOutputBuilder
impl Send for DescribeInferenceExperimentOutputBuilder
impl Sync for DescribeInferenceExperimentOutputBuilder
impl Unpin for DescribeInferenceExperimentOutputBuilder
impl UnwindSafe for DescribeInferenceExperimentOutputBuilder
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);