#[non_exhaustive]pub struct SamplingRuleBuilder { /* private fields */ }
Expand description
A builder for SamplingRule
.
Implementations§
Source§impl SamplingRuleBuilder
impl SamplingRuleBuilder
Sourcepub fn rule_name(self, input: impl Into<String>) -> Self
pub fn rule_name(self, input: impl Into<String>) -> Self
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
Sourcepub fn set_rule_name(self, input: Option<String>) -> Self
pub fn set_rule_name(self, input: Option<String>) -> Self
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
Sourcepub fn get_rule_name(&self) -> &Option<String>
pub fn get_rule_name(&self) -> &Option<String>
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
Sourcepub fn rule_arn(self, input: impl Into<String>) -> Self
pub fn rule_arn(self, input: impl Into<String>) -> Self
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
Sourcepub fn set_rule_arn(self, input: Option<String>) -> Self
pub fn set_rule_arn(self, input: Option<String>) -> Self
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
Sourcepub fn get_rule_arn(&self) -> &Option<String>
pub fn get_rule_arn(&self) -> &Option<String>
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
Sourcepub fn resource_arn(self, input: impl Into<String>) -> Self
pub fn resource_arn(self, input: impl Into<String>) -> Self
Matches the ARN of the Amazon Web Services resource on which the service runs.
This field is required.Sourcepub fn set_resource_arn(self, input: Option<String>) -> Self
pub fn set_resource_arn(self, input: Option<String>) -> Self
Matches the ARN of the Amazon Web Services resource on which the service runs.
Sourcepub fn get_resource_arn(&self) -> &Option<String>
pub fn get_resource_arn(&self) -> &Option<String>
Matches the ARN of the Amazon Web Services resource on which the service runs.
Sourcepub fn priority(self, input: i32) -> Self
pub fn priority(self, input: i32) -> Self
The priority of the sampling rule.
This field is required.Sourcepub fn set_priority(self, input: Option<i32>) -> Self
pub fn set_priority(self, input: Option<i32>) -> Self
The priority of the sampling rule.
Sourcepub fn get_priority(&self) -> &Option<i32>
pub fn get_priority(&self) -> &Option<i32>
The priority of the sampling rule.
Sourcepub fn fixed_rate(self, input: f64) -> Self
pub fn fixed_rate(self, input: f64) -> Self
The percentage of matching requests to instrument, after the reservoir is exhausted.
This field is required.Sourcepub fn set_fixed_rate(self, input: Option<f64>) -> Self
pub fn set_fixed_rate(self, input: Option<f64>) -> Self
The percentage of matching requests to instrument, after the reservoir is exhausted.
Sourcepub fn get_fixed_rate(&self) -> &Option<f64>
pub fn get_fixed_rate(&self) -> &Option<f64>
The percentage of matching requests to instrument, after the reservoir is exhausted.
Sourcepub fn reservoir_size(self, input: i32) -> Self
pub fn reservoir_size(self, input: i32) -> Self
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
This field is required.Sourcepub fn set_reservoir_size(self, input: Option<i32>) -> Self
pub fn set_reservoir_size(self, input: Option<i32>) -> Self
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
Sourcepub fn get_reservoir_size(&self) -> &Option<i32>
pub fn get_reservoir_size(&self) -> &Option<i32>
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
Sourcepub fn service_name(self, input: impl Into<String>) -> Self
pub fn service_name(self, input: impl Into<String>) -> Self
Matches the name
that the service uses to identify itself in segments.
Sourcepub fn set_service_name(self, input: Option<String>) -> Self
pub fn set_service_name(self, input: Option<String>) -> Self
Matches the name
that the service uses to identify itself in segments.
Sourcepub fn get_service_name(&self) -> &Option<String>
pub fn get_service_name(&self) -> &Option<String>
Matches the name
that the service uses to identify itself in segments.
Sourcepub fn service_type(self, input: impl Into<String>) -> Self
pub fn service_type(self, input: impl Into<String>) -> Self
Matches the origin
that the service uses to identify its type in segments.
Sourcepub fn set_service_type(self, input: Option<String>) -> Self
pub fn set_service_type(self, input: Option<String>) -> Self
Matches the origin
that the service uses to identify its type in segments.
Sourcepub fn get_service_type(&self) -> &Option<String>
pub fn get_service_type(&self) -> &Option<String>
Matches the origin
that the service uses to identify its type in segments.
Sourcepub fn host(self, input: impl Into<String>) -> Self
pub fn host(self, input: impl Into<String>) -> Self
Matches the hostname from a request URL.
This field is required.Sourcepub fn http_method(self, input: impl Into<String>) -> Self
pub fn http_method(self, input: impl Into<String>) -> Self
Matches the HTTP method of a request.
This field is required.Sourcepub fn set_http_method(self, input: Option<String>) -> Self
pub fn set_http_method(self, input: Option<String>) -> Self
Matches the HTTP method of a request.
Sourcepub fn get_http_method(&self) -> &Option<String>
pub fn get_http_method(&self) -> &Option<String>
Matches the HTTP method of a request.
Sourcepub fn url_path(self, input: impl Into<String>) -> Self
pub fn url_path(self, input: impl Into<String>) -> Self
Matches the path from a request URL.
This field is required.Sourcepub fn set_url_path(self, input: Option<String>) -> Self
pub fn set_url_path(self, input: Option<String>) -> Self
Matches the path from a request URL.
Sourcepub fn get_url_path(&self) -> &Option<String>
pub fn get_url_path(&self) -> &Option<String>
Matches the path from a request URL.
Sourcepub fn version(self, input: i32) -> Self
pub fn version(self, input: i32) -> Self
The version of the sampling rule format (1
).
Sourcepub fn set_version(self, input: Option<i32>) -> Self
pub fn set_version(self, input: Option<i32>) -> Self
The version of the sampling rule format (1
).
Sourcepub fn get_version(&self) -> &Option<i32>
pub fn get_version(&self) -> &Option<i32>
The version of the sampling rule format (1
).
Sourcepub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to attributes
.
To override the contents of this collection use set_attributes
.
Matches attributes derived from the request.
Sourcepub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
Matches attributes derived from the request.
Sourcepub fn get_attributes(&self) -> &Option<HashMap<String, String>>
pub fn get_attributes(&self) -> &Option<HashMap<String, String>>
Matches attributes derived from the request.
Sourcepub fn build(self) -> Result<SamplingRule, BuildError>
pub fn build(self) -> Result<SamplingRule, BuildError>
Consumes the builder and constructs a SamplingRule
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for SamplingRuleBuilder
impl Clone for SamplingRuleBuilder
Source§fn clone(&self) -> SamplingRuleBuilder
fn clone(&self) -> SamplingRuleBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SamplingRuleBuilder
impl Debug for SamplingRuleBuilder
Source§impl Default for SamplingRuleBuilder
impl Default for SamplingRuleBuilder
Source§fn default() -> SamplingRuleBuilder
fn default() -> SamplingRuleBuilder
Source§impl PartialEq for SamplingRuleBuilder
impl PartialEq for SamplingRuleBuilder
impl StructuralPartialEq for SamplingRuleBuilder
Auto Trait Implementations§
impl Freeze for SamplingRuleBuilder
impl RefUnwindSafe for SamplingRuleBuilder
impl Send for SamplingRuleBuilder
impl Sync for SamplingRuleBuilder
impl Unpin for SamplingRuleBuilder
impl UnwindSafe for SamplingRuleBuilder
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>
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);