SamplingRule class

A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.

Constructors

SamplingRule({required double fixedRate, required String hTTPMethod, required String host, required int priority, required int reservoirSize, required String resourceARN, required String serviceName, required String serviceType, required String uRLPath, required int version, Map<String, String>? attributes, String? ruleARN, String? ruleName})
SamplingRule.fromJson(Map<String, dynamic> json)
factory

Properties

attributes → Map<String, String>?
Matches attributes derived from the request.
final
fixedRate → double
The percentage of matching requests to instrument, after the reservoir is exhausted.
final
hashCode → int
The hash code for this object.
no setterinherited
host → String
Matches the hostname from a request URL.
final
hTTPMethod → String
Matches the HTTP method of a request.
final
priority → int
The priority of the sampling rule.
final
reservoirSize → int
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.
final
resourceARN → String
Matches the ARN of the AWS resource on which the service runs.
final
ruleARN → String?
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
final
ruleName → String?
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceName → String
Matches the name that the service uses to identify itself in segments.
final
serviceType → String
Matches the origin that the service uses to identify its type in segments.
final
uRLPath → String
Matches the path from a request URL.
final
version → int
The version of the sampling rule format (1).
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited