File Coverage

blib/lib/Paws/SQS/MessageAttributeValue.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::MessageAttributeValue;
2 1     1   276 use Moose;
  1     1   1  
  1         6  
  1         533  
  1         2  
  1         8  
3             has BinaryListValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'BinaryListValue', request_name => 'BinaryListValue', traits => ['NameInRequest','NameInRequest']);
4             has BinaryValue => (is => 'ro', isa => 'Str');
5             has DataType => (is => 'ro', isa => 'Str', required => 1);
6             has StringListValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'StringListValue', request_name => 'StringListValue', traits => ['NameInRequest','NameInRequest']);
7             has StringValue => (is => 'ro', isa => 'Str');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::SQS::MessageAttributeValue
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::SQS::MessageAttributeValue object:
26              
27             $service_obj->Method(Att1 => { BinaryListValues => $value, ..., StringValue => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::SQS::MessageAttributeValue object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->BinaryListValues
35              
36             =head1 DESCRIPTION
37              
38             The user-specified message attribute value. For string data types, the
39             C<Value> attribute has the same restrictions on the content as the
40             message body. For more information, see C< SendMessage.>
41              
42             C<Name>, C<type>, C<value> and the message body must not be empty or
43             null. All parts of the message attribute, including C<Name>, C<Type>,
44             and C<Value>, are part of the message size restriction (256 KB or
45             262,144 bytes).
46              
47             =head1 ATTRIBUTES
48              
49              
50             =head2 BinaryListValues => ArrayRef[Str|Undef]
51              
52             Not implemented. Reserved for future use.
53              
54              
55             =head2 BinaryValue => Str
56              
57             Binary type attributes can store any binary data, such as compressed
58             data, encrypted data, or images.
59              
60              
61             =head2 B<REQUIRED> DataType => Str
62              
63             Amazon SQS supports the following logical data types: C<String>,
64             C<Number>, and C<Binary>. For the C<Number> data type, you must use
65             C<StringValue>.
66              
67             You can also append custom labels. For more information, see Message
68             Attribute Data Types and Validation in the I<Amazon SQS Developer
69             Guide>.
70              
71              
72             =head2 StringListValues => ArrayRef[Str|Undef]
73              
74             Not implemented. Reserved for future use.
75              
76              
77             =head2 StringValue => Str
78              
79             Strings are Unicode with UTF-8 binary encoding. For a list of code
80             values, see ASCII Printable Characters.
81              
82              
83              
84             =head1 SEE ALSO
85              
86             This class forms part of L<Paws>, describing an object used in L<Paws::SQS>
87              
88             =head1 BUGS and CONTRIBUTIONS
89              
90             The source code is located here: https://github.com/pplu/aws-sdk-perl
91              
92             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
93              
94             =cut
95