#[non_exhaustive]pub struct TrialComponentBuilder { /* private fields */ }
Expand description
A builder for TrialComponent
.
Implementations§
Source§impl TrialComponentBuilder
impl TrialComponentBuilder
Sourcepub fn trial_component_name(self, input: impl Into<String>) -> Self
pub fn trial_component_name(self, input: impl Into<String>) -> Self
The name of the trial component.
Sourcepub fn set_trial_component_name(self, input: Option<String>) -> Self
pub fn set_trial_component_name(self, input: Option<String>) -> Self
The name of the trial component.
Sourcepub fn get_trial_component_name(&self) -> &Option<String>
pub fn get_trial_component_name(&self) -> &Option<String>
The name of the trial component.
Sourcepub fn display_name(self, input: impl Into<String>) -> Self
pub fn display_name(self, input: impl Into<String>) -> Self
The name of the component as displayed. If DisplayName
isn't specified, TrialComponentName
is displayed.
Sourcepub fn set_display_name(self, input: Option<String>) -> Self
pub fn set_display_name(self, input: Option<String>) -> Self
The name of the component as displayed. If DisplayName
isn't specified, TrialComponentName
is displayed.
Sourcepub fn get_display_name(&self) -> &Option<String>
pub fn get_display_name(&self) -> &Option<String>
The name of the component as displayed. If DisplayName
isn't specified, TrialComponentName
is displayed.
Sourcepub fn trial_component_arn(self, input: impl Into<String>) -> Self
pub fn trial_component_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the trial component.
Sourcepub fn set_trial_component_arn(self, input: Option<String>) -> Self
pub fn set_trial_component_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the trial component.
Sourcepub fn get_trial_component_arn(&self) -> &Option<String>
pub fn get_trial_component_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the trial component.
Sourcepub fn source(self, input: TrialComponentSource) -> Self
pub fn source(self, input: TrialComponentSource) -> Self
The Amazon Resource Name (ARN) and job type of the source of the component.
Sourcepub fn set_source(self, input: Option<TrialComponentSource>) -> Self
pub fn set_source(self, input: Option<TrialComponentSource>) -> Self
The Amazon Resource Name (ARN) and job type of the source of the component.
Sourcepub fn get_source(&self) -> &Option<TrialComponentSource>
pub fn get_source(&self) -> &Option<TrialComponentSource>
The Amazon Resource Name (ARN) and job type of the source of the component.
Sourcepub fn status(self, input: TrialComponentStatus) -> Self
pub fn status(self, input: TrialComponentStatus) -> Self
The status of the trial component.
Sourcepub fn set_status(self, input: Option<TrialComponentStatus>) -> Self
pub fn set_status(self, input: Option<TrialComponentStatus>) -> Self
The status of the trial component.
Sourcepub fn get_status(&self) -> &Option<TrialComponentStatus>
pub fn get_status(&self) -> &Option<TrialComponentStatus>
The status of the trial component.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
When the component started.
Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
When the component started.
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
When the component started.
Sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
When the component ended.
Sourcepub fn get_end_time(&self) -> &Option<DateTime>
pub fn get_end_time(&self) -> &Option<DateTime>
When the component ended.
Sourcepub fn creation_time(self, input: DateTime) -> Self
pub fn creation_time(self, input: DateTime) -> Self
When the component was created.
Sourcepub fn set_creation_time(self, input: Option<DateTime>) -> Self
pub fn set_creation_time(self, input: Option<DateTime>) -> Self
When the component was created.
Sourcepub fn get_creation_time(&self) -> &Option<DateTime>
pub fn get_creation_time(&self) -> &Option<DateTime>
When the component was created.
Sourcepub fn created_by(self, input: UserContext) -> Self
pub fn created_by(self, input: UserContext) -> Self
Who created the trial component.
Sourcepub fn set_created_by(self, input: Option<UserContext>) -> Self
pub fn set_created_by(self, input: Option<UserContext>) -> Self
Who created the trial component.
Sourcepub fn get_created_by(&self) -> &Option<UserContext>
pub fn get_created_by(&self) -> &Option<UserContext>
Who created the trial component.
Sourcepub fn last_modified_time(self, input: DateTime) -> Self
pub fn last_modified_time(self, input: DateTime) -> Self
When the component was last modified.
Sourcepub fn set_last_modified_time(self, input: Option<DateTime>) -> Self
pub fn set_last_modified_time(self, input: Option<DateTime>) -> Self
When the component was last modified.
Sourcepub fn get_last_modified_time(&self) -> &Option<DateTime>
pub fn get_last_modified_time(&self) -> &Option<DateTime>
When the component was last modified.
Sourcepub fn last_modified_by(self, input: UserContext) -> Self
pub fn last_modified_by(self, input: UserContext) -> Self
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Sourcepub fn set_last_modified_by(self, input: Option<UserContext>) -> Self
pub fn set_last_modified_by(self, input: Option<UserContext>) -> Self
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Sourcepub fn get_last_modified_by(&self) -> &Option<UserContext>
pub fn get_last_modified_by(&self) -> &Option<UserContext>
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Sourcepub fn parameters(
self,
k: impl Into<String>,
v: TrialComponentParameterValue,
) -> Self
pub fn parameters( self, k: impl Into<String>, v: TrialComponentParameterValue, ) -> Self
Adds a key-value pair to parameters
.
To override the contents of this collection use set_parameters
.
The hyperparameters of the component.
Sourcepub fn set_parameters(
self,
input: Option<HashMap<String, TrialComponentParameterValue>>,
) -> Self
pub fn set_parameters( self, input: Option<HashMap<String, TrialComponentParameterValue>>, ) -> Self
The hyperparameters of the component.
Sourcepub fn get_parameters(
&self,
) -> &Option<HashMap<String, TrialComponentParameterValue>>
pub fn get_parameters( &self, ) -> &Option<HashMap<String, TrialComponentParameterValue>>
The hyperparameters of the component.
Sourcepub fn input_artifacts(
self,
k: impl Into<String>,
v: TrialComponentArtifact,
) -> Self
pub fn input_artifacts( self, k: impl Into<String>, v: TrialComponentArtifact, ) -> Self
Adds a key-value pair to input_artifacts
.
To override the contents of this collection use set_input_artifacts
.
The input artifacts of the component.
Sourcepub fn set_input_artifacts(
self,
input: Option<HashMap<String, TrialComponentArtifact>>,
) -> Self
pub fn set_input_artifacts( self, input: Option<HashMap<String, TrialComponentArtifact>>, ) -> Self
The input artifacts of the component.
Sourcepub fn get_input_artifacts(
&self,
) -> &Option<HashMap<String, TrialComponentArtifact>>
pub fn get_input_artifacts( &self, ) -> &Option<HashMap<String, TrialComponentArtifact>>
The input artifacts of the component.
Sourcepub fn output_artifacts(
self,
k: impl Into<String>,
v: TrialComponentArtifact,
) -> Self
pub fn output_artifacts( self, k: impl Into<String>, v: TrialComponentArtifact, ) -> Self
Adds a key-value pair to output_artifacts
.
To override the contents of this collection use set_output_artifacts
.
The output artifacts of the component.
Sourcepub fn set_output_artifacts(
self,
input: Option<HashMap<String, TrialComponentArtifact>>,
) -> Self
pub fn set_output_artifacts( self, input: Option<HashMap<String, TrialComponentArtifact>>, ) -> Self
The output artifacts of the component.
Sourcepub fn get_output_artifacts(
&self,
) -> &Option<HashMap<String, TrialComponentArtifact>>
pub fn get_output_artifacts( &self, ) -> &Option<HashMap<String, TrialComponentArtifact>>
The output artifacts of the component.
Sourcepub fn metrics(self, input: TrialComponentMetricSummary) -> Self
pub fn metrics(self, input: TrialComponentMetricSummary) -> Self
Appends an item to metrics
.
To override the contents of this collection use set_metrics
.
The metrics for the component.
Sourcepub fn set_metrics(
self,
input: Option<Vec<TrialComponentMetricSummary>>,
) -> Self
pub fn set_metrics( self, input: Option<Vec<TrialComponentMetricSummary>>, ) -> Self
The metrics for the component.
Sourcepub fn get_metrics(&self) -> &Option<Vec<TrialComponentMetricSummary>>
pub fn get_metrics(&self) -> &Option<Vec<TrialComponentMetricSummary>>
The metrics for the component.
Sourcepub fn metadata_properties(self, input: MetadataProperties) -> Self
pub fn metadata_properties(self, input: MetadataProperties) -> Self
Metadata properties of the tracking entity, trial, or trial component.
Sourcepub fn set_metadata_properties(self, input: Option<MetadataProperties>) -> Self
pub fn set_metadata_properties(self, input: Option<MetadataProperties>) -> Self
Metadata properties of the tracking entity, trial, or trial component.
Sourcepub fn get_metadata_properties(&self) -> &Option<MetadataProperties>
pub fn get_metadata_properties(&self) -> &Option<MetadataProperties>
Metadata properties of the tracking entity, trial, or trial component.
Sourcepub fn source_detail(self, input: TrialComponentSourceDetail) -> Self
pub fn source_detail(self, input: TrialComponentSourceDetail) -> Self
Details of the source of the component.
Sourcepub fn set_source_detail(
self,
input: Option<TrialComponentSourceDetail>,
) -> Self
pub fn set_source_detail( self, input: Option<TrialComponentSourceDetail>, ) -> Self
Details of the source of the component.
Sourcepub fn get_source_detail(&self) -> &Option<TrialComponentSourceDetail>
pub fn get_source_detail(&self) -> &Option<TrialComponentSourceDetail>
Details of the source of the component.
Sourcepub fn lineage_group_arn(self, input: impl Into<String>) -> Self
pub fn lineage_group_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the lineage group resource.
Sourcepub fn set_lineage_group_arn(self, input: Option<String>) -> Self
pub fn set_lineage_group_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the lineage group resource.
Sourcepub fn get_lineage_group_arn(&self) -> &Option<String>
pub fn get_lineage_group_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the lineage group resource.
The list of tags that are associated with the component. You can use Search API to search on the tags.
The list of tags that are associated with the component. You can use Search API to search on the tags.
Sourcepub fn parents(self, input: Parent) -> Self
pub fn parents(self, input: Parent) -> Self
Appends an item to parents
.
To override the contents of this collection use set_parents
.
An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.
Sourcepub fn set_parents(self, input: Option<Vec<Parent>>) -> Self
pub fn set_parents(self, input: Option<Vec<Parent>>) -> Self
An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.
Sourcepub fn get_parents(&self) -> &Option<Vec<Parent>>
pub fn get_parents(&self) -> &Option<Vec<Parent>>
An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.
Sourcepub fn set_run_name(self, input: Option<String>) -> Self
pub fn set_run_name(self, input: Option<String>) -> Self
The name of the experiment run.
Sourcepub fn get_run_name(&self) -> &Option<String>
pub fn get_run_name(&self) -> &Option<String>
The name of the experiment run.
Sourcepub fn build(self) -> TrialComponent
pub fn build(self) -> TrialComponent
Consumes the builder and constructs a TrialComponent
.
Trait Implementations§
Source§impl Clone for TrialComponentBuilder
impl Clone for TrialComponentBuilder
Source§fn clone(&self) -> TrialComponentBuilder
fn clone(&self) -> TrialComponentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TrialComponentBuilder
impl Debug for TrialComponentBuilder
Source§impl Default for TrialComponentBuilder
impl Default for TrialComponentBuilder
Source§fn default() -> TrialComponentBuilder
fn default() -> TrialComponentBuilder
Source§impl PartialEq for TrialComponentBuilder
impl PartialEq for TrialComponentBuilder
impl StructuralPartialEq for TrialComponentBuilder
Auto Trait Implementations§
impl Freeze for TrialComponentBuilder
impl RefUnwindSafe for TrialComponentBuilder
impl Send for TrialComponentBuilder
impl Sync for TrialComponentBuilder
impl Unpin for TrialComponentBuilder
impl UnwindSafe for TrialComponentBuilder
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);