#[non_exhaustive]pub struct GetScheduleOutputBuilder { /* private fields */ }
Expand description
A builder for GetScheduleOutput
.
Implementations§
Source§impl GetScheduleOutputBuilder
impl GetScheduleOutputBuilder
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the schedule.
Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the schedule.
Sourcepub fn group_name(self, input: impl Into<String>) -> Self
pub fn group_name(self, input: impl Into<String>) -> Self
The name of the schedule group associated with this schedule.
Sourcepub fn set_group_name(self, input: Option<String>) -> Self
pub fn set_group_name(self, input: Option<String>) -> Self
The name of the schedule group associated with this schedule.
Sourcepub fn get_group_name(&self) -> &Option<String>
pub fn get_group_name(&self) -> &Option<String>
The name of the schedule group associated with this schedule.
Sourcepub fn schedule_expression(self, input: impl Into<String>) -> Self
pub fn schedule_expression(self, input: impl Into<String>) -> Self
The expression that defines when the schedule runs. The following formats are supported.
-
at
expression -at(yyyy-mm-ddThh:mm:ss)
-
rate
expression -rate(value unit)
-
cron
expression -cron(fields)
You can use at
expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate
and cron
expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
A cron
expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year)
.
A rate
expression consists of a value as a positive integer, and a unit with the following options: minute
| minutes
| hour
| hours
| day
| days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
Sourcepub fn set_schedule_expression(self, input: Option<String>) -> Self
pub fn set_schedule_expression(self, input: Option<String>) -> Self
The expression that defines when the schedule runs. The following formats are supported.
-
at
expression -at(yyyy-mm-ddThh:mm:ss)
-
rate
expression -rate(value unit)
-
cron
expression -cron(fields)
You can use at
expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate
and cron
expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
A cron
expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year)
.
A rate
expression consists of a value as a positive integer, and a unit with the following options: minute
| minutes
| hour
| hours
| day
| days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
Sourcepub fn get_schedule_expression(&self) -> &Option<String>
pub fn get_schedule_expression(&self) -> &Option<String>
The expression that defines when the schedule runs. The following formats are supported.
-
at
expression -at(yyyy-mm-ddThh:mm:ss)
-
rate
expression -rate(value unit)
-
cron
expression -cron(fields)
You can use at
expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate
and cron
expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
A cron
expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year)
.
A rate
expression consists of a value as a positive integer, and a unit with the following options: minute
| minutes
| hour
| hours
| day
| days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
Sourcepub fn start_date(self, input: DateTime) -> Self
pub fn start_date(self, input: DateTime) -> Self
The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate
you specify. EventBridge Scheduler ignores StartDate
for one-time schedules.
Sourcepub fn set_start_date(self, input: Option<DateTime>) -> Self
pub fn set_start_date(self, input: Option<DateTime>) -> Self
The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate
you specify. EventBridge Scheduler ignores StartDate
for one-time schedules.
Sourcepub fn get_start_date(&self) -> &Option<DateTime>
pub fn get_start_date(&self) -> &Option<DateTime>
The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate
you specify. EventBridge Scheduler ignores StartDate
for one-time schedules.
Sourcepub fn end_date(self, input: DateTime) -> Self
pub fn end_date(self, input: DateTime) -> Self
The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate
you specify. EventBridge Scheduler ignores EndDate
for one-time schedules.
Sourcepub fn set_end_date(self, input: Option<DateTime>) -> Self
pub fn set_end_date(self, input: Option<DateTime>) -> Self
The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate
you specify. EventBridge Scheduler ignores EndDate
for one-time schedules.
Sourcepub fn get_end_date(&self) -> &Option<DateTime>
pub fn get_end_date(&self) -> &Option<DateTime>
The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate
you specify. EventBridge Scheduler ignores EndDate
for one-time schedules.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the schedule.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the schedule.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the schedule.
Sourcepub fn schedule_expression_timezone(self, input: impl Into<String>) -> Self
pub fn schedule_expression_timezone(self, input: impl Into<String>) -> Self
The timezone in which the scheduling expression is evaluated.
Sourcepub fn set_schedule_expression_timezone(self, input: Option<String>) -> Self
pub fn set_schedule_expression_timezone(self, input: Option<String>) -> Self
The timezone in which the scheduling expression is evaluated.
Sourcepub fn get_schedule_expression_timezone(&self) -> &Option<String>
pub fn get_schedule_expression_timezone(&self) -> &Option<String>
The timezone in which the scheduling expression is evaluated.
Sourcepub fn state(self, input: ScheduleState) -> Self
pub fn state(self, input: ScheduleState) -> Self
Specifies whether the schedule is enabled or disabled.
Sourcepub fn set_state(self, input: Option<ScheduleState>) -> Self
pub fn set_state(self, input: Option<ScheduleState>) -> Self
Specifies whether the schedule is enabled or disabled.
Sourcepub fn get_state(&self) -> &Option<ScheduleState>
pub fn get_state(&self) -> &Option<ScheduleState>
Specifies whether the schedule is enabled or disabled.
Sourcepub fn creation_date(self, input: DateTime) -> Self
pub fn creation_date(self, input: DateTime) -> Self
The time at which the schedule was created.
Sourcepub fn set_creation_date(self, input: Option<DateTime>) -> Self
pub fn set_creation_date(self, input: Option<DateTime>) -> Self
The time at which the schedule was created.
Sourcepub fn get_creation_date(&self) -> &Option<DateTime>
pub fn get_creation_date(&self) -> &Option<DateTime>
The time at which the schedule was created.
Sourcepub fn last_modification_date(self, input: DateTime) -> Self
pub fn last_modification_date(self, input: DateTime) -> Self
The time at which the schedule was last modified.
Sourcepub fn set_last_modification_date(self, input: Option<DateTime>) -> Self
pub fn set_last_modification_date(self, input: Option<DateTime>) -> Self
The time at which the schedule was last modified.
Sourcepub fn get_last_modification_date(&self) -> &Option<DateTime>
pub fn get_last_modification_date(&self) -> &Option<DateTime>
The time at which the schedule was last modified.
Sourcepub fn kms_key_arn(self, input: impl Into<String>) -> Self
pub fn kms_key_arn(self, input: impl Into<String>) -> Self
The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
Sourcepub fn set_kms_key_arn(self, input: Option<String>) -> Self
pub fn set_kms_key_arn(self, input: Option<String>) -> Self
The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
Sourcepub fn get_kms_key_arn(&self) -> &Option<String>
pub fn get_kms_key_arn(&self) -> &Option<String>
The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
Sourcepub fn set_target(self, input: Option<Target>) -> Self
pub fn set_target(self, input: Option<Target>) -> Self
The schedule target.
Sourcepub fn get_target(&self) -> &Option<Target>
pub fn get_target(&self) -> &Option<Target>
The schedule target.
Sourcepub fn flexible_time_window(self, input: FlexibleTimeWindow) -> Self
pub fn flexible_time_window(self, input: FlexibleTimeWindow) -> Self
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
Sourcepub fn set_flexible_time_window(self, input: Option<FlexibleTimeWindow>) -> Self
pub fn set_flexible_time_window(self, input: Option<FlexibleTimeWindow>) -> Self
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
Sourcepub fn get_flexible_time_window(&self) -> &Option<FlexibleTimeWindow>
pub fn get_flexible_time_window(&self) -> &Option<FlexibleTimeWindow>
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
Sourcepub fn action_after_completion(self, input: ActionAfterCompletion) -> Self
pub fn action_after_completion(self, input: ActionAfterCompletion) -> Self
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
Sourcepub fn set_action_after_completion(
self,
input: Option<ActionAfterCompletion>,
) -> Self
pub fn set_action_after_completion( self, input: Option<ActionAfterCompletion>, ) -> Self
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
Sourcepub fn get_action_after_completion(&self) -> &Option<ActionAfterCompletion>
pub fn get_action_after_completion(&self) -> &Option<ActionAfterCompletion>
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
Sourcepub fn build(self) -> GetScheduleOutput
pub fn build(self) -> GetScheduleOutput
Consumes the builder and constructs a GetScheduleOutput
.
Trait Implementations§
Source§impl Clone for GetScheduleOutputBuilder
impl Clone for GetScheduleOutputBuilder
Source§fn clone(&self) -> GetScheduleOutputBuilder
fn clone(&self) -> GetScheduleOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GetScheduleOutputBuilder
impl Debug for GetScheduleOutputBuilder
Source§impl Default for GetScheduleOutputBuilder
impl Default for GetScheduleOutputBuilder
Source§fn default() -> GetScheduleOutputBuilder
fn default() -> GetScheduleOutputBuilder
Source§impl PartialEq for GetScheduleOutputBuilder
impl PartialEq for GetScheduleOutputBuilder
impl StructuralPartialEq for GetScheduleOutputBuilder
Auto Trait Implementations§
impl Freeze for GetScheduleOutputBuilder
impl RefUnwindSafe for GetScheduleOutputBuilder
impl Send for GetScheduleOutputBuilder
impl Sync for GetScheduleOutputBuilder
impl Unpin for GetScheduleOutputBuilder
impl UnwindSafe for GetScheduleOutputBuilder
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);