blib/lib/Paws/XRay/SamplingRule.pm untested

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