#[non_exhaustive]pub struct RateBasedRuleBuilder { /* private fields */ }
Expand description
A builder for RateBasedRule
.
Implementations§
Source§impl RateBasedRuleBuilder
impl RateBasedRuleBuilder
Sourcepub fn rule_id(self, input: impl Into<String>) -> Self
pub fn rule_id(self, input: impl Into<String>) -> Self
A unique identifier for a RateBasedRule
. You use RuleId
to get more information about a RateBasedRule
(see GetRateBasedRule
), update a RateBasedRule
(see UpdateRateBasedRule
), insert a RateBasedRule
into a WebACL
or delete one from a WebACL
(see UpdateWebACL
), or delete a RateBasedRule
from AWS WAF (see DeleteRateBasedRule
).
Sourcepub fn set_rule_id(self, input: Option<String>) -> Self
pub fn set_rule_id(self, input: Option<String>) -> Self
A unique identifier for a RateBasedRule
. You use RuleId
to get more information about a RateBasedRule
(see GetRateBasedRule
), update a RateBasedRule
(see UpdateRateBasedRule
), insert a RateBasedRule
into a WebACL
or delete one from a WebACL
(see UpdateWebACL
), or delete a RateBasedRule
from AWS WAF (see DeleteRateBasedRule
).
Sourcepub fn get_rule_id(&self) -> &Option<String>
pub fn get_rule_id(&self) -> &Option<String>
A unique identifier for a RateBasedRule
. You use RuleId
to get more information about a RateBasedRule
(see GetRateBasedRule
), update a RateBasedRule
(see UpdateRateBasedRule
), insert a RateBasedRule
into a WebACL
or delete one from a WebACL
(see UpdateWebACL
), or delete a RateBasedRule
from AWS WAF (see DeleteRateBasedRule
).
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
A friendly name or description for a RateBasedRule
. You can't change the name of a RateBasedRule
after you create it.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
A friendly name or description for a RateBasedRule
. You can't change the name of a RateBasedRule
after you create it.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
A friendly name or description for a RateBasedRule
. You can't change the name of a RateBasedRule
after you create it.
Sourcepub fn metric_name(self, input: impl Into<String>) -> Self
pub fn metric_name(self, input: impl Into<String>) -> Self
A friendly name or description for the metrics for a RateBasedRule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule
.
Sourcepub fn set_metric_name(self, input: Option<String>) -> Self
pub fn set_metric_name(self, input: Option<String>) -> Self
A friendly name or description for the metrics for a RateBasedRule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule
.
Sourcepub fn get_metric_name(&self) -> &Option<String>
pub fn get_metric_name(&self) -> &Option<String>
A friendly name or description for the metrics for a RateBasedRule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule
.
Sourcepub fn match_predicates(self, input: Predicate) -> Self
pub fn match_predicates(self, input: Predicate) -> Self
Appends an item to match_predicates
.
To override the contents of this collection use set_match_predicates
.
The Predicates
object contains one Predicate
element for each ByteMatchSet
, IPSet
, or SqlInjectionMatchSet
object that you want to include in a RateBasedRule
.
Sourcepub fn set_match_predicates(self, input: Option<Vec<Predicate>>) -> Self
pub fn set_match_predicates(self, input: Option<Vec<Predicate>>) -> Self
The Predicates
object contains one Predicate
element for each ByteMatchSet
, IPSet
, or SqlInjectionMatchSet
object that you want to include in a RateBasedRule
.
Sourcepub fn get_match_predicates(&self) -> &Option<Vec<Predicate>>
pub fn get_match_predicates(&self) -> &Option<Vec<Predicate>>
The Predicates
object contains one Predicate
element for each ByteMatchSet
, IPSet
, or SqlInjectionMatchSet
object that you want to include in a RateBasedRule
.
Sourcepub fn rate_key(self, input: RateKey) -> Self
pub fn rate_key(self, input: RateKey) -> Self
The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey
is IP
. IP
indicates that requests arriving from the same IP address are subject to the RateLimit
that is specified in the RateBasedRule
.
Sourcepub fn set_rate_key(self, input: Option<RateKey>) -> Self
pub fn set_rate_key(self, input: Option<RateKey>) -> Self
The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey
is IP
. IP
indicates that requests arriving from the same IP address are subject to the RateLimit
that is specified in the RateBasedRule
.
Sourcepub fn get_rate_key(&self) -> &Option<RateKey>
pub fn get_rate_key(&self) -> &Option<RateKey>
The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey
is IP
. IP
indicates that requests arriving from the same IP address are subject to the RateLimit
that is specified in the RateBasedRule
.
Sourcepub fn rate_limit(self, input: i64) -> Self
pub fn rate_limit(self, input: i64) -> Self
The maximum number of requests, which have an identical value in the field specified by the RateKey
, allowed in a five-minute period. If the number of requests exceeds the RateLimit
and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
Sourcepub fn set_rate_limit(self, input: Option<i64>) -> Self
pub fn set_rate_limit(self, input: Option<i64>) -> Self
The maximum number of requests, which have an identical value in the field specified by the RateKey
, allowed in a five-minute period. If the number of requests exceeds the RateLimit
and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
Sourcepub fn get_rate_limit(&self) -> &Option<i64>
pub fn get_rate_limit(&self) -> &Option<i64>
The maximum number of requests, which have an identical value in the field specified by the RateKey
, allowed in a five-minute period. If the number of requests exceeds the RateLimit
and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
Sourcepub fn build(self) -> Result<RateBasedRule, BuildError>
pub fn build(self) -> Result<RateBasedRule, BuildError>
Consumes the builder and constructs a RateBasedRule
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for RateBasedRuleBuilder
impl Clone for RateBasedRuleBuilder
Source§fn clone(&self) -> RateBasedRuleBuilder
fn clone(&self) -> RateBasedRuleBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RateBasedRuleBuilder
impl Debug for RateBasedRuleBuilder
Source§impl Default for RateBasedRuleBuilder
impl Default for RateBasedRuleBuilder
Source§fn default() -> RateBasedRuleBuilder
fn default() -> RateBasedRuleBuilder
Source§impl PartialEq for RateBasedRuleBuilder
impl PartialEq for RateBasedRuleBuilder
impl StructuralPartialEq for RateBasedRuleBuilder
Auto Trait Implementations§
impl Freeze for RateBasedRuleBuilder
impl RefUnwindSafe for RateBasedRuleBuilder
impl Send for RateBasedRuleBuilder
impl Sync for RateBasedRuleBuilder
impl Unpin for RateBasedRuleBuilder
impl UnwindSafe for RateBasedRuleBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);