Struct aws_sdk_xray::types::builders::SamplingRuleBuilder

#[non_exhaustive]
pub struct SamplingRuleBuilder { /* private fields */ }

A builder for SamplingRule.

Implementations

impl SamplingRuleBuilder

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.

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.

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.

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.

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.

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.

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.

pub fn set_resource_arn(self, input: Option<String>) -> Self

Matches the ARN of the Amazon Web Services resource on which the service runs.

pub fn get_resource_arn(&self) -> &Option<String>

Matches the ARN of the Amazon Web Services resource on which the service runs.

pub fn priority(self, input: i32) -> Self

The priority of the sampling rule.

This field is required.

pub fn set_priority(self, input: Option<i32>) -> Self

The priority of the sampling rule.

pub fn get_priority(&self) -> &Option<i32>

The priority of the sampling rule.

pub fn fixed_rate(self, input: f64) -> Self

The percentage of matching requests to instrument, after the reservoir is exhausted.

This field is required.

pub fn set_fixed_rate(self, input: Option<f64>) -> Self

The percentage of matching requests to instrument, after the reservoir is exhausted.

pub fn get_fixed_rate(&self) -> &Option<f64>

The percentage of matching requests to instrument, after the reservoir is exhausted.

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.

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.

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.

pub fn service_name(self, input: impl Into<String>) -> Self

Matches the name that the service uses to identify itself in segments.

This field is required.

pub fn set_service_name(self, input: Option<String>) -> Self

Matches the name that the service uses to identify itself in segments.

pub fn get_service_name(&self) -> &Option<String>

Matches the name that the service uses to identify itself in segments.

pub fn service_type(self, input: impl Into<String>) -> Self

Matches the origin that the service uses to identify its type in segments.

This field is required.

pub fn set_service_type(self, input: Option<String>) -> Self

Matches the origin that the service uses to identify its type in segments.

pub fn get_service_type(&self) -> &Option<String>

Matches the origin that the service uses to identify its type in segments.

pub fn host(self, input: impl Into<String>) -> Self

Matches the hostname from a request URL.

This field is required.

pub fn set_host(self, input: Option<String>) -> Self

Matches the hostname from a request URL.

pub fn get_host(&self) -> &Option<String>

Matches the hostname from a request URL.

pub fn http_method(self, input: impl Into<String>) -> Self

Matches the HTTP method of a request.

This field is required.

pub fn set_http_method(self, input: Option<String>) -> Self

Matches the HTTP method of a request.

pub fn get_http_method(&self) -> &Option<String>

Matches the HTTP method of a request.

pub fn url_path(self, input: impl Into<String>) -> Self

Matches the path from a request URL.

This field is required.

pub fn set_url_path(self, input: Option<String>) -> Self

Matches the path from a request URL.

pub fn get_url_path(&self) -> &Option<String>

Matches the path from a request URL.

pub fn version(self, input: i32) -> Self

The version of the sampling rule format (1).

This field is required.

pub fn set_version(self, input: Option<i32>) -> Self

The version of the sampling rule format (1).

pub fn get_version(&self) -> &Option<i32>

The version of the sampling rule format (1).

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.

pub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self

Matches attributes derived from the request.

pub fn get_attributes(&self) -> &Option<HashMap<String, String>>

Matches attributes derived from the request.

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:

• resource_arn
• priority
• service_name
• service_type
• host
• http_method
• url_path
• version

Trait Implementations

impl Clone for SamplingRuleBuilder

fn clone(&self) -> SamplingRuleBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SamplingRuleBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SamplingRuleBuilder

fn default() -> SamplingRuleBuilder

Returns the “default value” for a type.

impl PartialEq for SamplingRuleBuilder

fn eq(&self, other: &SamplingRuleBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SamplingRuleBuilder