#[non_exhaustive]pub struct PredictiveScalingPolicyConfigurationBuilder { /* private fields */ }Expand description
A builder for PredictiveScalingPolicyConfiguration.
Implementations§
Source§impl PredictiveScalingPolicyConfigurationBuilder
impl PredictiveScalingPolicyConfigurationBuilder
Sourcepub fn metric_specifications(
self,
input: PredictiveScalingMetricSpecification,
) -> Self
pub fn metric_specifications( self, input: PredictiveScalingMetricSpecification, ) -> Self
Appends an item to metric_specifications.
To override the contents of this collection use set_metric_specifications.
This structure includes the metrics and target utilization to use for predictive scaling.
This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
Sourcepub fn set_metric_specifications(
self,
input: Option<Vec<PredictiveScalingMetricSpecification>>,
) -> Self
pub fn set_metric_specifications( self, input: Option<Vec<PredictiveScalingMetricSpecification>>, ) -> Self
This structure includes the metrics and target utilization to use for predictive scaling.
This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
Sourcepub fn get_metric_specifications(
&self,
) -> &Option<Vec<PredictiveScalingMetricSpecification>>
pub fn get_metric_specifications( &self, ) -> &Option<Vec<PredictiveScalingMetricSpecification>>
This structure includes the metrics and target utilization to use for predictive scaling.
This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
Sourcepub fn mode(self, input: PredictiveScalingMode) -> Self
pub fn mode(self, input: PredictiveScalingMode) -> Self
The predictive scaling mode. Defaults to ForecastOnly if not specified.
Sourcepub fn set_mode(self, input: Option<PredictiveScalingMode>) -> Self
pub fn set_mode(self, input: Option<PredictiveScalingMode>) -> Self
The predictive scaling mode. Defaults to ForecastOnly if not specified.
Sourcepub fn get_mode(&self) -> &Option<PredictiveScalingMode>
pub fn get_mode(&self) -> &Option<PredictiveScalingMode>
The predictive scaling mode. Defaults to ForecastOnly if not specified.
Sourcepub fn scheduling_buffer_time(self, input: i32) -> Self
pub fn scheduling_buffer_time(self, input: i32) -> Self
The amount of time, in seconds, that the start time can be advanced.
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
Sourcepub fn set_scheduling_buffer_time(self, input: Option<i32>) -> Self
pub fn set_scheduling_buffer_time(self, input: Option<i32>) -> Self
The amount of time, in seconds, that the start time can be advanced.
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
Sourcepub fn get_scheduling_buffer_time(&self) -> &Option<i32>
pub fn get_scheduling_buffer_time(&self) -> &Option<i32>
The amount of time, in seconds, that the start time can be advanced.
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
Sourcepub fn max_capacity_breach_behavior(
self,
input: PredictiveScalingMaxCapacityBreachBehavior,
) -> Self
pub fn max_capacity_breach_behavior( self, input: PredictiveScalingMaxCapacityBreachBehavior, ) -> Self
Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.
Sourcepub fn set_max_capacity_breach_behavior(
self,
input: Option<PredictiveScalingMaxCapacityBreachBehavior>,
) -> Self
pub fn set_max_capacity_breach_behavior( self, input: Option<PredictiveScalingMaxCapacityBreachBehavior>, ) -> Self
Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.
Sourcepub fn get_max_capacity_breach_behavior(
&self,
) -> &Option<PredictiveScalingMaxCapacityBreachBehavior>
pub fn get_max_capacity_breach_behavior( &self, ) -> &Option<PredictiveScalingMaxCapacityBreachBehavior>
Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.
Sourcepub fn max_capacity_buffer(self, input: i32) -> Self
pub fn max_capacity_buffer(self, input: i32) -> Self
The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.
Sourcepub fn set_max_capacity_buffer(self, input: Option<i32>) -> Self
pub fn set_max_capacity_buffer(self, input: Option<i32>) -> Self
The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.
Sourcepub fn get_max_capacity_buffer(&self) -> &Option<i32>
pub fn get_max_capacity_buffer(&self) -> &Option<i32>
The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.
Sourcepub fn build(self) -> Result<PredictiveScalingPolicyConfiguration, BuildError>
pub fn build(self) -> Result<PredictiveScalingPolicyConfiguration, BuildError>
Consumes the builder and constructs a PredictiveScalingPolicyConfiguration.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for PredictiveScalingPolicyConfigurationBuilder
impl Clone for PredictiveScalingPolicyConfigurationBuilder
Source§fn clone(&self) -> PredictiveScalingPolicyConfigurationBuilder
fn clone(&self) -> PredictiveScalingPolicyConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for PredictiveScalingPolicyConfigurationBuilder
impl Default for PredictiveScalingPolicyConfigurationBuilder
Source§fn default() -> PredictiveScalingPolicyConfigurationBuilder
fn default() -> PredictiveScalingPolicyConfigurationBuilder
Source§impl PartialEq for PredictiveScalingPolicyConfigurationBuilder
impl PartialEq for PredictiveScalingPolicyConfigurationBuilder
Source§fn eq(&self, other: &PredictiveScalingPolicyConfigurationBuilder) -> bool
fn eq(&self, other: &PredictiveScalingPolicyConfigurationBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for PredictiveScalingPolicyConfigurationBuilder
Auto Trait Implementations§
impl Freeze for PredictiveScalingPolicyConfigurationBuilder
impl RefUnwindSafe for PredictiveScalingPolicyConfigurationBuilder
impl Send for PredictiveScalingPolicyConfigurationBuilder
impl Sync for PredictiveScalingPolicyConfigurationBuilder
impl Unpin for PredictiveScalingPolicyConfigurationBuilder
impl UnwindSafe for PredictiveScalingPolicyConfigurationBuilder
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);