#[non_exhaustive]pub struct TumblingWindowBuilder { /* private fields */ }Expand description
A builder for TumblingWindow.
Implementations§
Source§impl TumblingWindowBuilder
impl TumblingWindowBuilder
Sourcepub fn interval(self, input: impl Into<String>) -> Self
pub fn interval(self, input: impl Into<String>) -> Self
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
This field is required.Sourcepub fn set_interval(self, input: Option<String>) -> Self
pub fn set_interval(self, input: Option<String>) -> Self
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
Sourcepub fn get_interval(&self) -> &Option<String>
pub fn get_interval(&self) -> &Option<String>
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
Sourcepub fn offset(self, input: impl Into<String>) -> Self
pub fn offset(self, input: impl Into<String>) -> Self
The offset for the tumbling window. The offset parameter accepts the following:
-
The offset time.
For example, if you specify
18hforoffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:-
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
-
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
-
-
The ISO 8601 format.
For example, if you specify
PT18Hforoffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:-
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
-
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
-
-
The 24-hour clock.
For example, if you specify
00:03:00foroffset,5mforinterval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC). -
The offset time zone.
For example, if you specify
2021-07-23T18:00-08foroffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:-
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
-
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
-
Sourcepub fn set_offset(self, input: Option<String>) -> Self
pub fn set_offset(self, input: Option<String>) -> Self
The offset for the tumbling window. The offset parameter accepts the following:
-
The offset time.
For example, if you specify
18hforoffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:-
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
-
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
-
-
The ISO 8601 format.
For example, if you specify
PT18Hforoffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:-
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
-
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
-
-
The 24-hour clock.
For example, if you specify
00:03:00foroffset,5mforinterval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC). -
The offset time zone.
For example, if you specify
2021-07-23T18:00-08foroffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:-
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
-
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
-
Sourcepub fn get_offset(&self) -> &Option<String>
pub fn get_offset(&self) -> &Option<String>
The offset for the tumbling window. The offset parameter accepts the following:
-
The offset time.
For example, if you specify
18hforoffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:-
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
-
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
-
-
The ISO 8601 format.
For example, if you specify
PT18Hforoffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:-
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
-
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
-
-
The 24-hour clock.
For example, if you specify
00:03:00foroffset,5mforinterval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC). -
The offset time zone.
For example, if you specify
2021-07-23T18:00-08foroffsetand1dforinterval, IoT SiteWise aggregates data in one of the following ways:-
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
-
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
-
Sourcepub fn build(self) -> Result<TumblingWindow, BuildError>
pub fn build(self) -> Result<TumblingWindow, BuildError>
Consumes the builder and constructs a TumblingWindow.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for TumblingWindowBuilder
impl Clone for TumblingWindowBuilder
Source§fn clone(&self) -> TumblingWindowBuilder
fn clone(&self) -> TumblingWindowBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for TumblingWindowBuilder
impl Debug for TumblingWindowBuilder
Source§impl Default for TumblingWindowBuilder
impl Default for TumblingWindowBuilder
Source§fn default() -> TumblingWindowBuilder
fn default() -> TumblingWindowBuilder
Source§impl PartialEq for TumblingWindowBuilder
impl PartialEq for TumblingWindowBuilder
impl StructuralPartialEq for TumblingWindowBuilder
Auto Trait Implementations§
impl Freeze for TumblingWindowBuilder
impl RefUnwindSafe for TumblingWindowBuilder
impl Send for TumblingWindowBuilder
impl Sync for TumblingWindowBuilder
impl Unpin for TumblingWindowBuilder
impl UnwindSafe for TumblingWindowBuilder
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);