File Coverage

blib/lib/Paws/S3/HeadObject.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              
2             package Paws::S3::HeadObject;
3 1     1   731 use Moose;
  1         3  
  1         9  
4             has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1);
5             has IfMatch => (is => 'ro', isa => 'Str', header_name => 'If-Match', traits => ['ParamInHeader']);
6             has IfModifiedSince => (is => 'ro', isa => 'Str', header_name => 'If-Modified-Since', traits => ['ParamInHeader']);
7             has IfNoneMatch => (is => 'ro', isa => 'Str', header_name => 'If-None-Match', traits => ['ParamInHeader']);
8             has IfUnmodifiedSince => (is => 'ro', isa => 'Str', header_name => 'If-Unmodified-Since', traits => ['ParamInHeader']);
9             has Key => (is => 'ro', isa => 'Str', uri_name => 'Key', traits => ['ParamInURI'], required => 1);
10             has PartNumber => (is => 'ro', isa => 'Int', query_name => 'partNumber', traits => ['ParamInQuery']);
11             has Range => (is => 'ro', isa => 'Str', header_name => 'Range', traits => ['ParamInHeader']);
12             has RequestPayer => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-payer', traits => ['ParamInHeader']);
13             has SSECustomerAlgorithm => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-algorithm', traits => ['ParamInHeader']);
14             has SSECustomerKey => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-key', traits => ['ParamInHeader']);
15             has SSECustomerKeyMD5 => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-key-MD5', traits => ['ParamInHeader']);
16             has VersionId => (is => 'ro', isa => 'Str', query_name => 'versionId', traits => ['ParamInQuery']);
17              
18 1     1   8492 use MooseX::ClassAttribute;
  1         3  
  1         24  
19              
20             class_has _api_call => (isa => 'Str', is => 'ro', default => 'HeadObject');
21             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}/{Key+}');
22             class_has _api_method => (isa => 'Str', is => 'ro', default => 'HEAD');
23             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::HeadObjectOutput');
24             class_has _result_key => (isa => 'Str', is => 'ro');
25            
26             1;
27              
28             ### main pod documentation begin ###
29              
30             =head1 NAME
31              
32             Paws::S3::HeadObject - Arguments for method HeadObject on Paws::S3
33              
34             =head1 DESCRIPTION
35              
36             This class represents the parameters used for calling the method HeadObject on the
37             Amazon Simple Storage Service service. Use the attributes of this class
38             as arguments to method HeadObject.
39              
40             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to HeadObject.
41              
42             As an example:
43              
44             $service_obj->HeadObject(Att1 => $value1, Att2 => $value2, ...);
45              
46             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 B<REQUIRED> Bucket => Str
52              
53              
54              
55              
56              
57             =head2 IfMatch => Str
58              
59             Return the object only if its entity tag (ETag) is the same as the one
60             specified, otherwise return a 412 (precondition failed).
61              
62              
63              
64             =head2 IfModifiedSince => Str
65              
66             Return the object only if it has been modified since the specified
67             time, otherwise return a 304 (not modified).
68              
69              
70              
71             =head2 IfNoneMatch => Str
72              
73             Return the object only if its entity tag (ETag) is different from the
74             one specified, otherwise return a 304 (not modified).
75              
76              
77              
78             =head2 IfUnmodifiedSince => Str
79              
80             Return the object only if it has not been modified since the specified
81             time, otherwise return a 412 (precondition failed).
82              
83              
84              
85             =head2 B<REQUIRED> Key => Str
86              
87              
88              
89              
90              
91             =head2 PartNumber => Int
92              
93             Part number of the object being read. This is a positive integer
94             between 1 and 10,000. Effectively performs a 'ranged' HEAD request for
95             the part specified. Useful querying about the size of the part and the
96             number of parts in this object.
97              
98              
99              
100             =head2 Range => Str
101              
102             Downloads the specified range bytes of an object. For more information
103             about the HTTP Range header, go to
104             http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
105              
106              
107              
108             =head2 RequestPayer => Str
109              
110              
111              
112             Valid values are: C<"requester">
113              
114             =head2 SSECustomerAlgorithm => Str
115              
116             Specifies the algorithm to use to when encrypting the object (e.g.,
117             AES256).
118              
119              
120              
121             =head2 SSECustomerKey => Str
122              
123             Specifies the customer-provided encryption key for Amazon S3 to use in
124             encrypting data. This value is used to store the object and then it is
125             discarded; Amazon does not store the encryption key. The key must be
126             appropriate for use with the algorithm specified in the
127             x-amz-server-side-encryption-customer-algorithm header.
128              
129              
130              
131             =head2 SSECustomerKeyMD5 => Str
132              
133             Specifies the 128-bit MD5 digest of the encryption key according to RFC
134             1321. Amazon S3 uses this header for a message integrity check to
135             ensure the encryption key was transmitted without error.
136              
137              
138              
139             =head2 VersionId => Str
140              
141             VersionId used to reference a specific version of the object.
142              
143              
144              
145              
146             =head1 SEE ALSO
147              
148             This class forms part of L<Paws>, documenting arguments for method HeadObject in L<Paws::S3>
149              
150             =head1 BUGS and CONTRIBUTIONS
151              
152             The source code is located here: https://github.com/pplu/aws-sdk-perl
153              
154             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
155              
156             =cut
157