#[non_exhaustive]pub struct QualityCheckStepMetadata {
pub check_type: Option<String>,
pub baseline_used_for_drift_check_statistics: Option<String>,
pub baseline_used_for_drift_check_constraints: Option<String>,
pub calculated_baseline_statistics: Option<String>,
pub calculated_baseline_constraints: Option<String>,
pub model_package_group_name: Option<String>,
pub violation_report: Option<String>,
pub check_job_arn: Option<String>,
pub skip_check: Option<bool>,
pub register_new_baseline: Option<bool>,
}
Expand description
Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.check_type: Option<String>
The type of the Quality check step.
baseline_used_for_drift_check_statistics: Option<String>
The Amazon S3 URI of the baseline statistics file used for the drift check.
baseline_used_for_drift_check_constraints: Option<String>
The Amazon S3 URI of the baseline constraints file used for the drift check.
calculated_baseline_statistics: Option<String>
The Amazon S3 URI of the newly calculated baseline statistics file.
calculated_baseline_constraints: Option<String>
The Amazon S3 URI of the newly calculated baseline constraints file.
model_package_group_name: Option<String>
The model package group name.
violation_report: Option<String>
The Amazon S3 URI of violation report if violations are detected.
check_job_arn: Option<String>
The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.
skip_check: Option<bool>
This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False
, the previous baseline of the configured check type must be available.
register_new_baseline: Option<bool>
This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints
and BaselineUsedForDriftCheckStatistics
. If it is set to False
, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints
and BaselineUsedForDriftCheckStatistics
properties.
Implementations§
Source§impl QualityCheckStepMetadata
impl QualityCheckStepMetadata
Sourcepub fn check_type(&self) -> Option<&str>
pub fn check_type(&self) -> Option<&str>
The type of the Quality check step.
Sourcepub fn baseline_used_for_drift_check_statistics(&self) -> Option<&str>
pub fn baseline_used_for_drift_check_statistics(&self) -> Option<&str>
The Amazon S3 URI of the baseline statistics file used for the drift check.
Sourcepub fn baseline_used_for_drift_check_constraints(&self) -> Option<&str>
pub fn baseline_used_for_drift_check_constraints(&self) -> Option<&str>
The Amazon S3 URI of the baseline constraints file used for the drift check.
Sourcepub fn calculated_baseline_statistics(&self) -> Option<&str>
pub fn calculated_baseline_statistics(&self) -> Option<&str>
The Amazon S3 URI of the newly calculated baseline statistics file.
Sourcepub fn calculated_baseline_constraints(&self) -> Option<&str>
pub fn calculated_baseline_constraints(&self) -> Option<&str>
The Amazon S3 URI of the newly calculated baseline constraints file.
Sourcepub fn model_package_group_name(&self) -> Option<&str>
pub fn model_package_group_name(&self) -> Option<&str>
The model package group name.
Sourcepub fn violation_report(&self) -> Option<&str>
pub fn violation_report(&self) -> Option<&str>
The Amazon S3 URI of violation report if violations are detected.
Sourcepub fn check_job_arn(&self) -> Option<&str>
pub fn check_job_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.
Sourcepub fn skip_check(&self) -> Option<bool>
pub fn skip_check(&self) -> Option<bool>
This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False
, the previous baseline of the configured check type must be available.
Sourcepub fn register_new_baseline(&self) -> Option<bool>
pub fn register_new_baseline(&self) -> Option<bool>
This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints
and BaselineUsedForDriftCheckStatistics
. If it is set to False
, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints
and BaselineUsedForDriftCheckStatistics
properties.
Source§impl QualityCheckStepMetadata
impl QualityCheckStepMetadata
Sourcepub fn builder() -> QualityCheckStepMetadataBuilder
pub fn builder() -> QualityCheckStepMetadataBuilder
Creates a new builder-style object to manufacture QualityCheckStepMetadata
.
Trait Implementations§
Source§impl Clone for QualityCheckStepMetadata
impl Clone for QualityCheckStepMetadata
Source§fn clone(&self) -> QualityCheckStepMetadata
fn clone(&self) -> QualityCheckStepMetadata
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for QualityCheckStepMetadata
impl Debug for QualityCheckStepMetadata
Source§impl PartialEq for QualityCheckStepMetadata
impl PartialEq for QualityCheckStepMetadata
impl StructuralPartialEq for QualityCheckStepMetadata
Auto Trait Implementations§
impl Freeze for QualityCheckStepMetadata
impl RefUnwindSafe for QualityCheckStepMetadata
impl Send for QualityCheckStepMetadata
impl Sync for QualityCheckStepMetadata
impl Unpin for QualityCheckStepMetadata
impl UnwindSafe for QualityCheckStepMetadata
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);