Struct aws_sdk_xray::types::SamplingRuleUpdate

#[non_exhaustive]
pub struct SamplingRuleUpdate {
    pub rule_name: Option<String>,
    pub rule_arn: Option<String>,
    pub resource_arn: Option<String>,
    pub priority: Option<i32>,
    pub fixed_rate: Option<f64>,
    pub reservoir_size: Option<i32>,
    pub host: Option<String>,
    pub service_name: Option<String>,
    pub service_type: Option<String>,
    pub http_method: Option<String>,
    pub url_path: Option<String>,
    pub attributes: Option<HashMap<String, String>>,
}

A document specifying changes to a sampling rule's configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rule_name: Option<String>

The name of the sampling rule. Specify a rule by either name or ARN, but not both.

rule_arn: Option<String>

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

resource_arn: Option<String>

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

priority: Option<i32>

The priority of the sampling rule.

fixed_rate: Option<f64>

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

reservoir_size: 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.

host: Option<String>

Matches the hostname from a request URL.

service_name: Option<String>

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

service_type: Option<String>

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

http_method: Option<String>

Matches the HTTP method of a request.

url_path: Option<String>

Matches the path from a request URL.

attributes: Option<HashMap<String, String>>

Matches attributes derived from the request.

Implementations

impl SamplingRuleUpdate

pub fn rule_name(&self) -> Option<&str>

The name of the sampling rule. Specify a rule by either name or ARN, but not both.

pub fn rule_arn(&self) -> Option<&str>

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

pub fn resource_arn(&self) -> Option<&str>

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

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

The priority of the sampling rule.

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

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

pub fn 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 host(&self) -> Option<&str>

Matches the hostname from a request URL.

pub fn service_name(&self) -> Option<&str>

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

pub fn service_type(&self) -> Option<&str>

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

pub fn http_method(&self) -> Option<&str>

Matches the HTTP method of a request.

pub fn url_path(&self) -> Option<&str>

Matches the path from a request URL.

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

Matches attributes derived from the request.

impl SamplingRuleUpdate

pub fn builder() -> SamplingRuleUpdateBuilder

Creates a new builder-style object to manufacture SamplingRuleUpdate.

Trait Implementations

impl Clone for SamplingRuleUpdate

fn clone(&self) -> SamplingRuleUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SamplingRuleUpdate

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

Formats the value using the given formatter.

impl PartialEq for SamplingRuleUpdate

fn eq(&self, other: &SamplingRuleUpdate) -> 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 SamplingRuleUpdate