| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::XRay::TraceSummary; | ||
| 3 | use Moose; | ||
| 4 | has Annotations => (is => 'ro', isa => 'Paws::XRay::Annotations'); | ||
| 5 | has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Paws::XRay::AvailabilityZoneDetail]'); | ||
| 6 | has Duration => (is => 'ro', isa => 'Num'); | ||
| 7 | has EntryPoint => (is => 'ro', isa => 'Paws::XRay::ServiceId'); | ||
| 8 | has ErrorRootCauses => (is => 'ro', isa => 'ArrayRef[Paws::XRay::ErrorRootCause]'); | ||
| 9 | has FaultRootCauses => (is => 'ro', isa => 'ArrayRef[Paws::XRay::FaultRootCause]'); | ||
| 10 | has HasError => (is => 'ro', isa => 'Bool'); | ||
| 11 | has HasFault => (is => 'ro', isa => 'Bool'); | ||
| 12 | has HasThrottle => (is => 'ro', isa => 'Bool'); | ||
| 13 | has Http => (is => 'ro', isa => 'Paws::XRay::Http'); | ||
| 14 | has Id => (is => 'ro', isa => 'Str'); | ||
| 15 | has InstanceIds => (is => 'ro', isa => 'ArrayRef[Paws::XRay::InstanceIdDetail]'); | ||
| 16 | has IsPartial => (is => 'ro', isa => 'Bool'); | ||
| 17 | has MatchedEventTime => (is => 'ro', isa => 'Str'); | ||
| 18 | has ResourceARNs => (is => 'ro', isa => 'ArrayRef[Paws::XRay::ResourceARNDetail]'); | ||
| 19 | has ResponseTime => (is => 'ro', isa => 'Num'); | ||
| 20 | has ResponseTimeRootCauses => (is => 'ro', isa => 'ArrayRef[Paws::XRay::ResponseTimeRootCause]'); | ||
| 21 | has Revision => (is => 'ro', isa => 'Int'); | ||
| 22 | has ServiceIds => (is => 'ro', isa => 'ArrayRef[Paws::XRay::ServiceId]'); | ||
| 23 | has Users => (is => 'ro', isa => 'ArrayRef[Paws::XRay::TraceUser]'); | ||
| 24 | |||
| 25 | 1; | ||
| 26 | |||
| 27 | ### main pod documentation begin ### | ||
| 28 | |||
| 29 | =head1 NAME | ||
| 30 | |||
| 31 | Paws::XRay::TraceSummary | ||
| 32 | |||
| 33 | =head1 USAGE | ||
| 34 | |||
| 35 | This class represents one of two things: | ||
| 36 | |||
| 37 | =head3 Arguments in a call to a service | ||
| 38 | |||
| 39 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 40 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 41 | |||
| 42 | As an example, if Att1 is expected to be a Paws::XRay::TraceSummary object: | ||
| 43 | |||
| 44 | $service_obj->Method(Att1 => { Annotations => $value, ..., Users => $value }); | ||
| 45 | |||
| 46 | =head3 Results returned from an API call | ||
| 47 | |||
| 48 | Use accessors for each attribute. If Att1 is expected to be an Paws::XRay::TraceSummary object: | ||
| 49 | |||
| 50 | $result = $service_obj->Method(...); | ||
| 51 | $result->Att1->Annotations | ||
| 52 | |||
| 53 | =head1 DESCRIPTION | ||
| 54 | |||
| 55 | Metadata generated from the segment documents in a trace. | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Annotations => L<Paws::XRay::Annotations> | ||
| 61 | |||
| 62 | Annotations from the trace's segment documents. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 AvailabilityZones => ArrayRef[L<Paws::XRay::AvailabilityZoneDetail>] | ||
| 66 | |||
| 67 | A list of Availability Zones for any zone corresponding to the trace | ||
| 68 | segments. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Duration => Num | ||
| 72 | |||
| 73 | The length of time in seconds between the start time of the root | ||
| 74 | segment and the end time of the last segment that completed. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 EntryPoint => L<Paws::XRay::ServiceId> | ||
| 78 | |||
| 79 | The root of a trace. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 ErrorRootCauses => ArrayRef[L<Paws::XRay::ErrorRootCause>] | ||
| 83 | |||
| 84 | A collection of ErrorRootCause structures corresponding to the trace | ||
| 85 | segments. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 FaultRootCauses => ArrayRef[L<Paws::XRay::FaultRootCause>] | ||
| 89 | |||
| 90 | A collection of FaultRootCause structures corresponding to the trace | ||
| 91 | segments. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 HasError => Bool | ||
| 95 | |||
| 96 | The root segment document has a 400 series error. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 HasFault => Bool | ||
| 100 | |||
| 101 | The root segment document has a 500 series error. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 HasThrottle => Bool | ||
| 105 | |||
| 106 | One or more of the segment documents has a 429 throttling error. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 Http => L<Paws::XRay::Http> | ||
| 110 | |||
| 111 | Information about the HTTP request served by the trace. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 Id => Str | ||
| 115 | |||
| 116 | The unique identifier for the request that generated the trace's | ||
| 117 | segments and subsegments. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 InstanceIds => ArrayRef[L<Paws::XRay::InstanceIdDetail>] | ||
| 121 | |||
| 122 | A list of EC2 instance IDs for any instance corresponding to the trace | ||
| 123 | segments. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 IsPartial => Bool | ||
| 127 | |||
| 128 | One or more of the segment documents is in progress. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 MatchedEventTime => Str | ||
| 132 | |||
| 133 | The matched time stamp of a defined event. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 ResourceARNs => ArrayRef[L<Paws::XRay::ResourceARNDetail>] | ||
| 137 | |||
| 138 | A list of resource ARNs for any resource corresponding to the trace | ||
| 139 | segments. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 ResponseTime => Num | ||
| 143 | |||
| 144 | The length of time in seconds between the start and end times of the | ||
| 145 | root segment. If the service performs work asynchronously, the response | ||
| 146 | time measures the time before the response is sent to the user, while | ||
| 147 | the duration measures the amount of time before the last traced | ||
| 148 | activity completes. | ||
| 149 | |||
| 150 | |||
| 151 | =head2 ResponseTimeRootCauses => ArrayRef[L<Paws::XRay::ResponseTimeRootCause>] | ||
| 152 | |||
| 153 | A collection of ResponseTimeRootCause structures corresponding to the | ||
| 154 | trace segments. | ||
| 155 | |||
| 156 | |||
| 157 | =head2 Revision => Int | ||
| 158 | |||
| 159 | The revision number of a trace. | ||
| 160 | |||
| 161 | |||
| 162 | =head2 ServiceIds => ArrayRef[L<Paws::XRay::ServiceId>] | ||
| 163 | |||
| 164 | Service IDs from the trace's segment documents. | ||
| 165 | |||
| 166 | |||
| 167 | =head2 Users => ArrayRef[L<Paws::XRay::TraceUser>] | ||
| 168 | |||
| 169 | Users from the trace's segment documents. | ||
| 170 | |||
| 171 | |||
| 172 | |||
| 173 | =head1 SEE ALSO | ||
| 174 | |||
| 175 | This class forms part of L<Paws>, describing an object used in L<Paws::XRay> | ||
| 176 | |||
| 177 | =head1 BUGS and CONTRIBUTIONS | ||
| 178 | |||
| 179 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 180 | |||
| 181 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 182 | |||
| 183 | =cut | ||
| 184 |