#[non_exhaustive]pub struct ScheduleConfigBuilder { /* private fields */ }
Expand description
A builder for ScheduleConfig
.
Implementations§
Source§impl ScheduleConfigBuilder
impl ScheduleConfigBuilder
Sourcepub fn schedule_expression(self, input: impl Into<String>) -> Self
pub fn schedule_expression(self, input: impl Into<String>) -> Self
A cron expression that describes details about the monitoring schedule.
The supported cron expressions are:
-
If you want to set the job to start every hour, use the following:
Hourly: cron(0 * ? * * *)
-
If you want to start the job daily:
cron(0 \[00-23\] ? * * *)
-
If you want to run the job one time, immediately, use the following keyword:
NOW
For example, the following are valid cron expressions:
-
Daily at noon UTC:
cron(0 12 ? * * *)
-
Daily at midnight UTC:
cron(0 0 ? * * *)
To support running every 6, 12 hours, the following are also supported:
cron(0 \[00-23\]/\[01-24\] ? * * *)
For example, the following are valid cron expressions:
-
Every 12 hours, starting at 5pm UTC:
cron(0 17/12 ? * * *)
-
Every two hours starting at midnight:
cron(0 0/2 ? * * *)
-
Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.
-
We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.
You can also specify the keyword NOW
to run the monitoring job immediately, one time, without recurring.
Sourcepub fn set_schedule_expression(self, input: Option<String>) -> Self
pub fn set_schedule_expression(self, input: Option<String>) -> Self
A cron expression that describes details about the monitoring schedule.
The supported cron expressions are:
-
If you want to set the job to start every hour, use the following:
Hourly: cron(0 * ? * * *)
-
If you want to start the job daily:
cron(0 \[00-23\] ? * * *)
-
If you want to run the job one time, immediately, use the following keyword:
NOW
For example, the following are valid cron expressions:
-
Daily at noon UTC:
cron(0 12 ? * * *)
-
Daily at midnight UTC:
cron(0 0 ? * * *)
To support running every 6, 12 hours, the following are also supported:
cron(0 \[00-23\]/\[01-24\] ? * * *)
For example, the following are valid cron expressions:
-
Every 12 hours, starting at 5pm UTC:
cron(0 17/12 ? * * *)
-
Every two hours starting at midnight:
cron(0 0/2 ? * * *)
-
Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.
-
We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.
You can also specify the keyword NOW
to run the monitoring job immediately, one time, without recurring.
Sourcepub fn get_schedule_expression(&self) -> &Option<String>
pub fn get_schedule_expression(&self) -> &Option<String>
A cron expression that describes details about the monitoring schedule.
The supported cron expressions are:
-
If you want to set the job to start every hour, use the following:
Hourly: cron(0 * ? * * *)
-
If you want to start the job daily:
cron(0 \[00-23\] ? * * *)
-
If you want to run the job one time, immediately, use the following keyword:
NOW
For example, the following are valid cron expressions:
-
Daily at noon UTC:
cron(0 12 ? * * *)
-
Daily at midnight UTC:
cron(0 0 ? * * *)
To support running every 6, 12 hours, the following are also supported:
cron(0 \[00-23\]/\[01-24\] ? * * *)
For example, the following are valid cron expressions:
-
Every 12 hours, starting at 5pm UTC:
cron(0 17/12 ? * * *)
-
Every two hours starting at midnight:
cron(0 0/2 ? * * *)
-
Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.
-
We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.
You can also specify the keyword NOW
to run the monitoring job immediately, one time, without recurring.
Sourcepub fn data_analysis_start_time(self, input: impl Into<String>) -> Self
pub fn data_analysis_start_time(self, input: impl Into<String>) -> Self
Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression
parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: "-PT5H"
.
The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime
parameter.
If you set ScheduleExpression
to NOW
, this parameter is required.
Sourcepub fn set_data_analysis_start_time(self, input: Option<String>) -> Self
pub fn set_data_analysis_start_time(self, input: Option<String>) -> Self
Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression
parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: "-PT5H"
.
The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime
parameter.
If you set ScheduleExpression
to NOW
, this parameter is required.
Sourcepub fn get_data_analysis_start_time(&self) -> &Option<String>
pub fn get_data_analysis_start_time(&self) -> &Option<String>
Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression
parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: "-PT5H"
.
The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime
parameter.
If you set ScheduleExpression
to NOW
, this parameter is required.
Sourcepub fn data_analysis_end_time(self, input: impl Into<String>) -> Self
pub fn data_analysis_end_time(self, input: impl Into<String>) -> Self
Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression
parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: "-PT1H"
.
The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime
parameter.
If you set ScheduleExpression
to NOW
, this parameter is required.
Sourcepub fn set_data_analysis_end_time(self, input: Option<String>) -> Self
pub fn set_data_analysis_end_time(self, input: Option<String>) -> Self
Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression
parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: "-PT1H"
.
The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime
parameter.
If you set ScheduleExpression
to NOW
, this parameter is required.
Sourcepub fn get_data_analysis_end_time(&self) -> &Option<String>
pub fn get_data_analysis_end_time(&self) -> &Option<String>
Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression
parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: "-PT1H"
.
The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime
parameter.
If you set ScheduleExpression
to NOW
, this parameter is required.
Sourcepub fn build(self) -> ScheduleConfig
pub fn build(self) -> ScheduleConfig
Consumes the builder and constructs a ScheduleConfig
.
Trait Implementations§
Source§impl Clone for ScheduleConfigBuilder
impl Clone for ScheduleConfigBuilder
Source§fn clone(&self) -> ScheduleConfigBuilder
fn clone(&self) -> ScheduleConfigBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ScheduleConfigBuilder
impl Debug for ScheduleConfigBuilder
Source§impl Default for ScheduleConfigBuilder
impl Default for ScheduleConfigBuilder
Source§fn default() -> ScheduleConfigBuilder
fn default() -> ScheduleConfigBuilder
Source§impl PartialEq for ScheduleConfigBuilder
impl PartialEq for ScheduleConfigBuilder
impl StructuralPartialEq for ScheduleConfigBuilder
Auto Trait Implementations§
impl Freeze for ScheduleConfigBuilder
impl RefUnwindSafe for ScheduleConfigBuilder
impl Send for ScheduleConfigBuilder
impl Sync for ScheduleConfigBuilder
impl Unpin for ScheduleConfigBuilder
impl UnwindSafe for ScheduleConfigBuilder
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);