« blib/lib/Paws/XRay/SamplingRuleRecord.pm
↑ Summary
blib/lib/Paws/XRay/SamplingStatisticSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::XRay::SamplingRuleUpdate; | ||
| 3 | use Moose; | ||
| 4 | has Attributes => (is => 'ro', isa => 'Paws::XRay::AttributeMap'); | ||
| 5 | has FixedRate => (is => 'ro', isa => 'Num'); | ||
| 6 | has Host => (is => 'ro', isa => 'Str'); | ||
| 7 | has HTTPMethod => (is => 'ro', isa => 'Str'); | ||
| 8 | has Priority => (is => 'ro', isa => 'Int'); | ||
| 9 | has ReservoirSize => (is => 'ro', isa => 'Int'); | ||
| 10 | has ResourceARN => (is => 'ro', isa => 'Str'); | ||
| 11 | has RuleARN => (is => 'ro', isa => 'Str'); | ||
| 12 | has RuleName => (is => 'ro', isa => 'Str'); | ||
| 13 | has ServiceName => (is => 'ro', isa => 'Str'); | ||
| 14 | has ServiceType => (is => 'ro', isa => 'Str'); | ||
| 15 | has URLPath => (is => 'ro', isa => 'Str'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::XRay::SamplingRuleUpdate | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::XRay::SamplingRuleUpdate object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { Attributes => $value, ..., URLPath => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::XRay::SamplingRuleUpdate object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->Attributes | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | A document specifying changes to a sampling rule's configuration. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Attributes => L<Paws::XRay::AttributeMap> | ||
| 53 | |||
| 54 | Matches attributes derived from the request. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 FixedRate => Num | ||
| 58 | |||
| 59 | The percentage of matching requests to instrument, after the reservoir | ||
| 60 | is exhausted. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 Host => Str | ||
| 64 | |||
| 65 | Matches the hostname from a request URL. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 HTTPMethod => Str | ||
| 69 | |||
| 70 | Matches the HTTP method of a request. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 Priority => Int | ||
| 74 | |||
| 75 | The priority of the sampling rule. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 ReservoirSize => Int | ||
| 79 | |||
| 80 | A fixed number of matching requests to instrument per second, prior to | ||
| 81 | applying the fixed rate. The reservoir is not used directly by | ||
| 82 | services, but applies to all services using the rule collectively. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 ResourceARN => Str | ||
| 86 | |||
| 87 | Matches the ARN of the AWS resource on which the service runs. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 RuleARN => Str | ||
| 91 | |||
| 92 | The ARN of the sampling rule. Specify a rule by either name or ARN, but | ||
| 93 | not both. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 RuleName => Str | ||
| 97 | |||
| 98 | The name of the sampling rule. Specify a rule by either name or ARN, | ||
| 99 | but not both. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 ServiceName => Str | ||
| 103 | |||
| 104 | Matches the C<name> that the service uses to identify itself in | ||
| 105 | segments. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 ServiceType => Str | ||
| 109 | |||
| 110 | Matches the C<origin> that the service uses to identify its type in | ||
| 111 | segments. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 URLPath => Str | ||
| 115 | |||
| 116 | Matches the path from a request URL. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head1 SEE ALSO | ||
| 121 | |||
| 122 | This class forms part of L<Paws>, describing an object used in L<Paws::XRay> | ||
| 123 | |||
| 124 | =head1 BUGS and CONTRIBUTIONS | ||
| 125 | |||
| 126 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 127 | |||
| 128 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 129 | |||
| 130 | =cut | ||
| 131 |