File Coverage

blib/lib/Paws/XRay/TraceSummary.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

line	stmt	sub	time	code
1				package Paws::XRay::TraceSummary;
2	1	1	304	use Moose;
	1		2
	1		6
3				has Annotations => (is => 'ro', isa => 'Paws::XRay::Annotations');
4				has Duration => (is => 'ro', isa => 'Num');
5				has HasError => (is => 'ro', isa => 'Bool');
6				has HasFault => (is => 'ro', isa => 'Bool');
7				has HasThrottle => (is => 'ro', isa => 'Bool');
8				has Http => (is => 'ro', isa => 'Paws::XRay::Http');
9				has Id => (is => 'ro', isa => 'Str');
10				has IsPartial => (is => 'ro', isa => 'Bool');
11				has ResponseTime => (is => 'ro', isa => 'Num');
12				has ServiceIds => (is => 'ro', isa => 'ArrayRef[Paws::XRay::ServiceId]');
13				has Users => (is => 'ro', isa => 'ArrayRef[Paws::XRay::TraceUser]');
14				1;
15
16				### main pod documentation begin ###
17
18				=head1 NAME
19
20				Paws::XRay::TraceSummary
21
22				=head1 USAGE
23
24				This class represents one of two things:
25
26				=head3 Arguments in a call to a service
27
28				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
29				Each attribute should be used as a named argument in the calls that expect this type of object.
30
31				As an example, if Att1 is expected to be a Paws::XRay::TraceSummary object:
32
33				$service_obj->Method(Att1 => { Annotations => $value, ..., Users => $value });
34
35				=head3 Results returned from an API call
36
37				Use accessors for each attribute. If Att1 is expected to be an Paws::XRay::TraceSummary object:
38
39				$result = $service_obj->Method(...);
40				$result->Att1->Annotations
41
42				=head1 DESCRIPTION
43
44				Metadata generated from the segment documents in a trace.
45
46				=head1 ATTRIBUTES
47
48
49				=head2 Annotations => L<Paws::XRay::Annotations>
50
51				Annotations from the trace's segment documents.
52
53
54				=head2 Duration => Num
55
56				The length of time in seconds between the start time of the root
57				segment and the end time of the last segment that completed.
58
59
60				=head2 HasError => Bool
61
62				One or more of the segment documents has a 400 series error.
63
64
65				=head2 HasFault => Bool
66
67				One or more of the segment documents has a 500 series error.
68
69
70				=head2 HasThrottle => Bool
71
72				One or more of the segment documents has a 429 throttling error.
73
74
75				=head2 Http => L<Paws::XRay::Http>
76
77				Information about the HTTP request served by the trace.
78
79
80				=head2 Id => Str
81
82				The unique identifier for the request that generated the trace's
83				segments and subsegments.
84
85
86				=head2 IsPartial => Bool
87
88				One or more of the segment documents is in progress.
89
90
91				=head2 ResponseTime => Num
92
93				The length of time in seconds between the start and end times of the
94				root segment. If the service performs work asynchronously, the response
95				time measures the time before the response is sent to the user, while
96				the duration measures the amount of time before the last traced
97				activity completes.
98
99
100				=head2 ServiceIds => ArrayRef[L<Paws::XRay::ServiceId>]
101
102				Service IDs from the trace's segment documents.
103
104
105				=head2 Users => ArrayRef[L<Paws::XRay::TraceUser>]
106
107				Users from the trace's segment documents.
108
109
110
111				=head1 SEE ALSO
112
113				This class forms part of L<Paws>, describing an object used in L<Paws::XRay>
114
115				=head1 BUGS and CONTRIBUTIONS
116
117				The source code is located here: https://github.com/pplu/aws-sdk-perl
118
119				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
120
121				=cut
122