| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::XRay::SamplingTargetDocument; | ||
| 3 | use Moose; | ||
| 4 | has FixedRate => (is => 'ro', isa => 'Num'); | ||
| 5 | has Interval => (is => 'ro', isa => 'Int'); | ||
| 6 | has ReservoirQuota => (is => 'ro', isa => 'Int'); | ||
| 7 | has ReservoirQuotaTTL => (is => 'ro', isa => 'Str'); | ||
| 8 | has RuleName => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::XRay::SamplingTargetDocument | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::XRay::SamplingTargetDocument object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { FixedRate => $value, ..., RuleName => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::XRay::SamplingTargetDocument object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->FixedRate | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Temporary changes to a sampling rule configuration. To meet the global | ||
| 41 | sampling target for a rule, X-Ray calculates a new reservoir for each | ||
| 42 | service based on the recent sampling results of all services that | ||
| 43 | called GetSamplingTargets. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 FixedRate => Num | ||
| 49 | |||
| 50 | The percentage of matching requests to instrument, after the reservoir | ||
| 51 | is exhausted. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Interval => Int | ||
| 55 | |||
| 56 | The number of seconds for the service to wait before getting sampling | ||
| 57 | targets again. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ReservoirQuota => Int | ||
| 61 | |||
| 62 | The number of requests per second that X-Ray allocated for this | ||
| 63 | service. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 ReservoirQuotaTTL => Str | ||
| 67 | |||
| 68 | When the reservoir quota expires. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 RuleName => Str | ||
| 72 | |||
| 73 | The name of the sampling rule. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head1 SEE ALSO | ||
| 78 | |||
| 79 | This class forms part of L<Paws>, describing an object used in L<Paws::XRay> | ||
| 80 | |||
| 81 | =head1 BUGS and CONTRIBUTIONS | ||
| 82 | |||
| 83 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 84 | |||
| 85 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 86 | |||
| 87 | =cut | ||
| 88 |