| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::XRay::Trace; | ||
| 3 | use Moose; | ||
| 4 | has Duration => (is => 'ro', isa => 'Num'); | ||
| 5 | has Id => (is => 'ro', isa => 'Str'); | ||
| 6 | has LimitExceeded => (is => 'ro', isa => 'Bool'); | ||
| 7 | has Segments => (is => 'ro', isa => 'ArrayRef[Paws::XRay::Segment]'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::XRay::Trace | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::XRay::Trace object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Duration => $value, ..., Segments => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::XRay::Trace object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Duration | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | A collection of segment documents with matching trace IDs. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 Duration => Num | ||
| 45 | |||
| 46 | The length of time in seconds between the start time of the root | ||
| 47 | segment and the end time of the last segment that completed. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Id => Str | ||
| 51 | |||
| 52 | The unique identifier for the request that generated the trace's | ||
| 53 | segments and subsegments. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 LimitExceeded => Bool | ||
| 57 | |||
| 58 | LimitExceeded is set to true when the trace has exceeded one of the | ||
| 59 | defined quotas. For more information about quotas, see AWS X-Ray | ||
| 60 | endpoints and quotas | ||
| 61 | (https://docs.aws.amazon.com/general/latest/gr/xray.html). | ||
| 62 | |||
| 63 | |||
| 64 | =head2 Segments => ArrayRef[L<Paws::XRay::Segment>] | ||
| 65 | |||
| 66 | Segment documents for the segments and subsegments that comprise the | ||
| 67 | trace. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, describing an object used in L<Paws::XRay> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |