File Coverage

blib/lib/Paws/SQS/Message.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Paws::SQS::Message;
2 1     1   277 use Moose;
  1     1   2  
  1         7  
  1         288  
  1         3  
  1         5  
3             has Attributes => (is => 'ro', isa => 'Paws::SQS::MessageSystemAttributeMap', request_name => 'Attribute', traits => ['NameInRequest']);
4             has Body => (is => 'ro', isa => 'Str');
5             has MD5OfBody => (is => 'ro', isa => 'Str');
6             has MD5OfMessageAttributes => (is => 'ro', isa => 'Str');
7             has MessageAttributes => (is => 'ro', isa => 'Paws::SQS::MessageBodyAttributeMap', request_name => 'MessageAttribute', traits => ['NameInRequest']);
8             has MessageId => (is => 'ro', isa => 'Str');
9             has ReceiptHandle => (is => 'ro', isa => 'Str');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::SQS::Message
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::SQS::Message object:
28              
29             $service_obj->Method(Att1 => { Attributes => $value, ..., ReceiptHandle => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::SQS::Message object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->Attributes
37              
38             =head1 DESCRIPTION
39              
40             An Amazon SQS message.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 Attributes => L<Paws::SQS::MessageSystemAttributeMap>
46              
47             C<SenderId>, C<SentTimestamp>, C<ApproximateReceiveCount>, and/or
48             C<ApproximateFirstReceiveTimestamp>. C<SentTimestamp> and
49             C<ApproximateFirstReceiveTimestamp> are each returned as an integer
50             representing the epoch time in milliseconds.
51              
52              
53             =head2 Body => Str
54              
55             The message's contents (not URL-encoded).
56              
57              
58             =head2 MD5OfBody => Str
59              
60             An MD5 digest of the non-URL-encoded message body string.
61              
62              
63             =head2 MD5OfMessageAttributes => Str
64              
65             An MD5 digest of the non-URL-encoded message attribute string. You can
66             use this attribute to verify that Amazon SQS received the message
67             correctly. Amazon SQS URL-decodes the message before creating the MD5
68             digest. For information about MD5, see RFC1321.
69              
70              
71             =head2 MessageAttributes => L<Paws::SQS::MessageBodyAttributeMap>
72              
73             Each message attribute consists of a C<Name>, C<Type>, and C<Value>.
74             For more information, see Message Attribute Items and Validation in the
75             I<Amazon SQS Developer Guide>.
76              
77              
78             =head2 MessageId => Str
79              
80             A unique identifier for the message. A C<MessageId>is considered unique
81             across all AWS accounts for an extended period of time.
82              
83              
84             =head2 ReceiptHandle => Str
85              
86             An identifier associated with the act of receiving the message. A new
87             receipt handle is returned every time you receive a message. When
88             deleting a message, you provide the last received receipt handle to
89             delete the message.
90              
91              
92              
93             =head1 SEE ALSO
94              
95             This class forms part of L<Paws>, describing an object used in L<Paws::SQS>
96              
97             =head1 BUGS and CONTRIBUTIONS
98              
99             The source code is located here: https://github.com/pplu/aws-sdk-perl
100              
101             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
102              
103             =cut
104