#[non_exhaustive]pub struct TrainingPlanSummaryBuilder { /* private fields */ }
Expand description
A builder for TrainingPlanSummary
.
Implementations§
Source§impl TrainingPlanSummaryBuilder
impl TrainingPlanSummaryBuilder
Sourcepub fn training_plan_arn(self, input: impl Into<String>) -> Self
pub fn training_plan_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN); of the training plan.
This field is required.Sourcepub fn set_training_plan_arn(self, input: Option<String>) -> Self
pub fn set_training_plan_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN); of the training plan.
Sourcepub fn get_training_plan_arn(&self) -> &Option<String>
pub fn get_training_plan_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN); of the training plan.
Sourcepub fn training_plan_name(self, input: impl Into<String>) -> Self
pub fn training_plan_name(self, input: impl Into<String>) -> Self
The name of the training plan.
This field is required.Sourcepub fn set_training_plan_name(self, input: Option<String>) -> Self
pub fn set_training_plan_name(self, input: Option<String>) -> Self
The name of the training plan.
Sourcepub fn get_training_plan_name(&self) -> &Option<String>
pub fn get_training_plan_name(&self) -> &Option<String>
The name of the training plan.
Sourcepub fn status(self, input: TrainingPlanStatus) -> Self
pub fn status(self, input: TrainingPlanStatus) -> Self
The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status
attribute within the TrainingPlanSummary
object.
Sourcepub fn set_status(self, input: Option<TrainingPlanStatus>) -> Self
pub fn set_status(self, input: Option<TrainingPlanStatus>) -> Self
The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status
attribute within the TrainingPlanSummary
object.
Sourcepub fn get_status(&self) -> &Option<TrainingPlanStatus>
pub fn get_status(&self) -> &Option<TrainingPlanStatus>
The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status
attribute within the TrainingPlanSummary
object.
Sourcepub fn status_message(self, input: impl Into<String>) -> Self
pub fn status_message(self, input: impl Into<String>) -> Self
A message providing additional information about the current status of the training plan.
Sourcepub fn set_status_message(self, input: Option<String>) -> Self
pub fn set_status_message(self, input: Option<String>) -> Self
A message providing additional information about the current status of the training plan.
Sourcepub fn get_status_message(&self) -> &Option<String>
pub fn get_status_message(&self) -> &Option<String>
A message providing additional information about the current status of the training plan.
Sourcepub fn duration_hours(self, input: i64) -> Self
pub fn duration_hours(self, input: i64) -> Self
The number of whole hours in the total duration for this training plan.
Sourcepub fn set_duration_hours(self, input: Option<i64>) -> Self
pub fn set_duration_hours(self, input: Option<i64>) -> Self
The number of whole hours in the total duration for this training plan.
Sourcepub fn get_duration_hours(&self) -> &Option<i64>
pub fn get_duration_hours(&self) -> &Option<i64>
The number of whole hours in the total duration for this training plan.
Sourcepub fn duration_minutes(self, input: i64) -> Self
pub fn duration_minutes(self, input: i64) -> Self
The additional minutes beyond whole hours in the total duration for this training plan.
Sourcepub fn set_duration_minutes(self, input: Option<i64>) -> Self
pub fn set_duration_minutes(self, input: Option<i64>) -> Self
The additional minutes beyond whole hours in the total duration for this training plan.
Sourcepub fn get_duration_minutes(&self) -> &Option<i64>
pub fn get_duration_minutes(&self) -> &Option<i64>
The additional minutes beyond whole hours in the total duration for this training plan.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The start time of the training plan.
Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The start time of the training plan.
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
The start time of the training plan.
Sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
The end time of the training plan.
Sourcepub fn get_end_time(&self) -> &Option<DateTime>
pub fn get_end_time(&self) -> &Option<DateTime>
The end time of the training plan.
Sourcepub fn upfront_fee(self, input: impl Into<String>) -> Self
pub fn upfront_fee(self, input: impl Into<String>) -> Self
The upfront fee for the training plan.
Sourcepub fn set_upfront_fee(self, input: Option<String>) -> Self
pub fn set_upfront_fee(self, input: Option<String>) -> Self
The upfront fee for the training plan.
Sourcepub fn get_upfront_fee(&self) -> &Option<String>
pub fn get_upfront_fee(&self) -> &Option<String>
The upfront fee for the training plan.
Sourcepub fn currency_code(self, input: impl Into<String>) -> Self
pub fn currency_code(self, input: impl Into<String>) -> Self
The currency code for the upfront fee (e.g., USD).
Sourcepub fn set_currency_code(self, input: Option<String>) -> Self
pub fn set_currency_code(self, input: Option<String>) -> Self
The currency code for the upfront fee (e.g., USD).
Sourcepub fn get_currency_code(&self) -> &Option<String>
pub fn get_currency_code(&self) -> &Option<String>
The currency code for the upfront fee (e.g., USD).
Sourcepub fn total_instance_count(self, input: i32) -> Self
pub fn total_instance_count(self, input: i32) -> Self
The total number of instances reserved in this training plan.
Sourcepub fn set_total_instance_count(self, input: Option<i32>) -> Self
pub fn set_total_instance_count(self, input: Option<i32>) -> Self
The total number of instances reserved in this training plan.
Sourcepub fn get_total_instance_count(&self) -> &Option<i32>
pub fn get_total_instance_count(&self) -> &Option<i32>
The total number of instances reserved in this training plan.
Sourcepub fn available_instance_count(self, input: i32) -> Self
pub fn available_instance_count(self, input: i32) -> Self
The number of instances currently available for use in this training plan.
Sourcepub fn set_available_instance_count(self, input: Option<i32>) -> Self
pub fn set_available_instance_count(self, input: Option<i32>) -> Self
The number of instances currently available for use in this training plan.
Sourcepub fn get_available_instance_count(&self) -> &Option<i32>
pub fn get_available_instance_count(&self) -> &Option<i32>
The number of instances currently available for use in this training plan.
Sourcepub fn in_use_instance_count(self, input: i32) -> Self
pub fn in_use_instance_count(self, input: i32) -> Self
The number of instances currently in use from this training plan.
Sourcepub fn set_in_use_instance_count(self, input: Option<i32>) -> Self
pub fn set_in_use_instance_count(self, input: Option<i32>) -> Self
The number of instances currently in use from this training plan.
Sourcepub fn get_in_use_instance_count(&self) -> &Option<i32>
pub fn get_in_use_instance_count(&self) -> &Option<i32>
The number of instances currently in use from this training plan.
Sourcepub fn target_resources(self, input: SageMakerResourceName) -> Self
pub fn target_resources(self, input: SageMakerResourceName) -> Self
Appends an item to target_resources
.
To override the contents of this collection use set_target_resources
.
The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.
Training plans are specific to their target resource.
-
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
-
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
Sourcepub fn set_target_resources(
self,
input: Option<Vec<SageMakerResourceName>>,
) -> Self
pub fn set_target_resources( self, input: Option<Vec<SageMakerResourceName>>, ) -> Self
The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.
Training plans are specific to their target resource.
-
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
-
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
Sourcepub fn get_target_resources(&self) -> &Option<Vec<SageMakerResourceName>>
pub fn get_target_resources(&self) -> &Option<Vec<SageMakerResourceName>>
The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.
Training plans are specific to their target resource.
-
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
-
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
Sourcepub fn reserved_capacity_summaries(self, input: ReservedCapacitySummary) -> Self
pub fn reserved_capacity_summaries(self, input: ReservedCapacitySummary) -> Self
Appends an item to reserved_capacity_summaries
.
To override the contents of this collection use set_reserved_capacity_summaries
.
A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
Sourcepub fn set_reserved_capacity_summaries(
self,
input: Option<Vec<ReservedCapacitySummary>>,
) -> Self
pub fn set_reserved_capacity_summaries( self, input: Option<Vec<ReservedCapacitySummary>>, ) -> Self
A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
Sourcepub fn get_reserved_capacity_summaries(
&self,
) -> &Option<Vec<ReservedCapacitySummary>>
pub fn get_reserved_capacity_summaries( &self, ) -> &Option<Vec<ReservedCapacitySummary>>
A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
Sourcepub fn build(self) -> TrainingPlanSummary
pub fn build(self) -> TrainingPlanSummary
Consumes the builder and constructs a TrainingPlanSummary
.
Trait Implementations§
Source§impl Clone for TrainingPlanSummaryBuilder
impl Clone for TrainingPlanSummaryBuilder
Source§fn clone(&self) -> TrainingPlanSummaryBuilder
fn clone(&self) -> TrainingPlanSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TrainingPlanSummaryBuilder
impl Debug for TrainingPlanSummaryBuilder
Source§impl Default for TrainingPlanSummaryBuilder
impl Default for TrainingPlanSummaryBuilder
Source§fn default() -> TrainingPlanSummaryBuilder
fn default() -> TrainingPlanSummaryBuilder
impl StructuralPartialEq for TrainingPlanSummaryBuilder
Auto Trait Implementations§
impl Freeze for TrainingPlanSummaryBuilder
impl RefUnwindSafe for TrainingPlanSummaryBuilder
impl Send for TrainingPlanSummaryBuilder
impl Sync for TrainingPlanSummaryBuilder
impl Unpin for TrainingPlanSummaryBuilder
impl UnwindSafe for TrainingPlanSummaryBuilder
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);