pub struct UpdateTrialComponentFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateTrialComponent
.
Updates one or more properties of a trial component.
Implementations§
Source§impl UpdateTrialComponentFluentBuilder
impl UpdateTrialComponentFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateTrialComponentInputBuilder
pub fn as_input(&self) -> &UpdateTrialComponentInputBuilder
Access the UpdateTrialComponent as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateTrialComponentOutput, SdkError<UpdateTrialComponentError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateTrialComponentOutput, SdkError<UpdateTrialComponentError, 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<UpdateTrialComponentOutput, UpdateTrialComponentError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateTrialComponentOutput, UpdateTrialComponentError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
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 component to update.
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 component to update.
Sourcepub fn get_trial_component_name(&self) -> &Option<String>
pub fn get_trial_component_name(&self) -> &Option<String>
The name of the component to update.
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. The name doesn't need to be unique. 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. The name doesn't need to be unique. 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. The name doesn't need to be unique. If DisplayName
isn't specified, TrialComponentName
is displayed.
Sourcepub fn status(self, input: TrialComponentStatus) -> Self
pub fn status(self, input: TrialComponentStatus) -> Self
The new status of the component.
Sourcepub fn set_status(self, input: Option<TrialComponentStatus>) -> Self
pub fn set_status(self, input: Option<TrialComponentStatus>) -> Self
The new status of the component.
Sourcepub fn get_status(&self) -> &Option<TrialComponentStatus>
pub fn get_status(&self) -> &Option<TrialComponentStatus>
The new status of the 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 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
.
Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
Sourcepub fn set_parameters(
self,
input: Option<HashMap<String, TrialComponentParameterValue>>,
) -> Self
pub fn set_parameters( self, input: Option<HashMap<String, TrialComponentParameterValue>>, ) -> Self
Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
Sourcepub fn get_parameters(
&self,
) -> &Option<HashMap<String, TrialComponentParameterValue>>
pub fn get_parameters( &self, ) -> &Option<HashMap<String, TrialComponentParameterValue>>
Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
Sourcepub fn parameters_to_remove(self, input: impl Into<String>) -> Self
pub fn parameters_to_remove(self, input: impl Into<String>) -> Self
Appends an item to ParametersToRemove
.
To override the contents of this collection use set_parameters_to_remove
.
The hyperparameters to remove from the component.
Sourcepub fn set_parameters_to_remove(self, input: Option<Vec<String>>) -> Self
pub fn set_parameters_to_remove(self, input: Option<Vec<String>>) -> Self
The hyperparameters to remove from the component.
Sourcepub fn get_parameters_to_remove(&self) -> &Option<Vec<String>>
pub fn get_parameters_to_remove(&self) -> &Option<Vec<String>>
The hyperparameters to remove from 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 InputArtifacts
.
To override the contents of this collection use set_input_artifacts
.
Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
Sourcepub fn set_input_artifacts(
self,
input: Option<HashMap<String, TrialComponentArtifact>>,
) -> Self
pub fn set_input_artifacts( self, input: Option<HashMap<String, TrialComponentArtifact>>, ) -> Self
Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
Sourcepub fn get_input_artifacts(
&self,
) -> &Option<HashMap<String, TrialComponentArtifact>>
pub fn get_input_artifacts( &self, ) -> &Option<HashMap<String, TrialComponentArtifact>>
Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
Sourcepub fn input_artifacts_to_remove(self, input: impl Into<String>) -> Self
pub fn input_artifacts_to_remove(self, input: impl Into<String>) -> Self
Appends an item to InputArtifactsToRemove
.
To override the contents of this collection use set_input_artifacts_to_remove
.
The input artifacts to remove from the component.
Sourcepub fn set_input_artifacts_to_remove(self, input: Option<Vec<String>>) -> Self
pub fn set_input_artifacts_to_remove(self, input: Option<Vec<String>>) -> Self
The input artifacts to remove from the component.
Sourcepub fn get_input_artifacts_to_remove(&self) -> &Option<Vec<String>>
pub fn get_input_artifacts_to_remove(&self) -> &Option<Vec<String>>
The input artifacts to remove from 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 OutputArtifacts
.
To override the contents of this collection use set_output_artifacts
.
Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
Sourcepub fn set_output_artifacts(
self,
input: Option<HashMap<String, TrialComponentArtifact>>,
) -> Self
pub fn set_output_artifacts( self, input: Option<HashMap<String, TrialComponentArtifact>>, ) -> Self
Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
Sourcepub fn get_output_artifacts(
&self,
) -> &Option<HashMap<String, TrialComponentArtifact>>
pub fn get_output_artifacts( &self, ) -> &Option<HashMap<String, TrialComponentArtifact>>
Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
Sourcepub fn output_artifacts_to_remove(self, input: impl Into<String>) -> Self
pub fn output_artifacts_to_remove(self, input: impl Into<String>) -> Self
Appends an item to OutputArtifactsToRemove
.
To override the contents of this collection use set_output_artifacts_to_remove
.
The output artifacts to remove from the component.
Sourcepub fn set_output_artifacts_to_remove(self, input: Option<Vec<String>>) -> Self
pub fn set_output_artifacts_to_remove(self, input: Option<Vec<String>>) -> Self
The output artifacts to remove from the component.
Sourcepub fn get_output_artifacts_to_remove(&self) -> &Option<Vec<String>>
pub fn get_output_artifacts_to_remove(&self) -> &Option<Vec<String>>
The output artifacts to remove from the component.
Trait Implementations§
Source§impl Clone for UpdateTrialComponentFluentBuilder
impl Clone for UpdateTrialComponentFluentBuilder
Source§fn clone(&self) -> UpdateTrialComponentFluentBuilder
fn clone(&self) -> UpdateTrialComponentFluentBuilder
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 UpdateTrialComponentFluentBuilder
impl !RefUnwindSafe for UpdateTrialComponentFluentBuilder
impl Send for UpdateTrialComponentFluentBuilder
impl Sync for UpdateTrialComponentFluentBuilder
impl Unpin for UpdateTrialComponentFluentBuilder
impl !UnwindSafe for UpdateTrialComponentFluentBuilder
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);