| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::XRay::Segment; | ||
| 3 | use Moose; | ||
| 4 | has Document => (is => 'ro', isa => 'Str'); | ||
| 5 | has Id => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::XRay::Segment | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::XRay::Segment object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Document => $value, ..., Id => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::XRay::Segment object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Document | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | A segment from a trace that has been ingested by the X-Ray service. The | ||
| 38 | segment can be compiled from documents uploaded with PutTraceSegments, | ||
| 39 | or an C<inferred> segment for a downstream service, generated from a | ||
| 40 | subsegment sent by the service that called it. | ||
| 41 | |||
| 42 | For the full segment document schema, see AWS X-Ray Segment Documents | ||
| 43 | (https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html) | ||
| 44 | in the I<AWS X-Ray Developer Guide>. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Document => Str | ||
| 50 | |||
| 51 | The segment document. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Id => Str | ||
| 55 | |||
| 56 | The segment's ID. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head1 SEE ALSO | ||
| 61 | |||
| 62 | This class forms part of L<Paws>, describing an object used in L<Paws::XRay> | ||
| 63 | |||
| 64 | =head1 BUGS and CONTRIBUTIONS | ||
| 65 | |||
| 66 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 67 | |||
| 68 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 69 | |||
| 70 | =cut | ||
| 71 |