blib/lib/Paws/S3/WriteGetObjectResponse.pm untested

filter: Statementstmt 0.0% 0 / 84 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 86 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::S3::WriteGetObjectResponse;
3 use Moose;
4 has AcceptRanges => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-accept-ranges', traits => ['ParamInHeader']);
5 has Body => (is => 'ro', isa => 'Str', traits => ['ParamInBody']);
6 has BucketKeyEnabled => (is => 'ro', isa => 'Bool', header_name => 'x-amz-fwd-header-x-amz-server-side-encryption-bucket-key-enabled', traits => ['ParamInHeader']);
7 has CacheControl => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-Cache-Control', traits => ['ParamInHeader']);
8 has ContentDisposition => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-Content-Disposition', traits => ['ParamInHeader']);
9 has ContentEncoding => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-Content-Encoding', traits => ['ParamInHeader']);
10 has ContentLanguage => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-Content-Language', traits => ['ParamInHeader']);
11 has ContentLength => (is => 'ro', isa => 'Int', header_name => 'Content-Length', traits => ['ParamInHeader']);
12 has ContentRange => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-Content-Range', traits => ['ParamInHeader']);
13 has ContentType => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-Content-Type', traits => ['ParamInHeader']);
14 has DeleteMarker => (is => 'ro', isa => 'Bool', header_name => 'x-amz-fwd-header-x-amz-delete-marker', traits => ['ParamInHeader']);
15 has ErrorCode => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-error-code', traits => ['ParamInHeader']);
16 has ErrorMessage => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-error-message', traits => ['ParamInHeader']);
17 has ETag => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-ETag', traits => ['ParamInHeader']);
18 has Expiration => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-expiration', traits => ['ParamInHeader']);
19 has Expires => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-Expires', traits => ['ParamInHeader']);
20 has LastModified => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-Last-Modified', traits => ['ParamInHeader']);
21 has Metadata => (is => 'ro', isa => 'Paws::S3::Metadata', header_prefix => 'x-amz-meta-', traits => ['ParamInHeaders']);
22 has MissingMeta => (is => 'ro', isa => 'Int', header_name => 'x-amz-fwd-header-x-amz-missing-meta', traits => ['ParamInHeader']);
23 has ObjectLockLegalHoldStatus => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-object-lock-legal-hold', traits => ['ParamInHeader']);
24 has ObjectLockMode => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-object-lock-mode', traits => ['ParamInHeader']);
25 has ObjectLockRetainUntilDate => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-object-lock-retain-until-date', traits => ['ParamInHeader']);
26 has PartsCount => (is => 'ro', isa => 'Int', header_name => 'x-amz-fwd-header-x-amz-mp-parts-count', traits => ['ParamInHeader']);
27 has ReplicationStatus => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-replication-status', traits => ['ParamInHeader']);
28 has RequestCharged => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-request-charged', traits => ['ParamInHeader']);
29 has RequestRoute => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-route', traits => ['ParamInHeader'], required => 1);
30 has RequestToken => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-token', traits => ['ParamInHeader'], required => 1);
31 has Restore => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-restore', traits => ['ParamInHeader']);
32 has ServerSideEncryption => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-server-side-encryption', traits => ['ParamInHeader']);
33 has SSECustomerAlgorithm => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-server-side-encryption-customer-algorithm', traits => ['ParamInHeader']);
34 has SSECustomerKeyMD5 => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-server-side-encryption-customer-key-MD5', traits => ['ParamInHeader']);
35 has SSEKMSKeyId => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-server-side-encryption-aws-kms-key-id', traits => ['ParamInHeader']);
36 has StatusCode => (is => 'ro', isa => 'Int', header_name => 'x-amz-fwd-status', traits => ['ParamInHeader']);
37 has StorageClass => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-storage-class', traits => ['ParamInHeader']);
38 has TagCount => (is => 'ro', isa => 'Int', header_name => 'x-amz-fwd-header-x-amz-tagging-count', traits => ['ParamInHeader']);
39 has VersionId => (is => 'ro', isa => 'Str', header_name => 'x-amz-fwd-header-x-amz-version-id', traits => ['ParamInHeader']);
40  
41  
42 use MooseX::ClassAttribute;
43  
44 class_has _api_call => (isa => 'Str', is => 'ro', default => 'WriteGetObjectResponse');
45 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/WriteGetObjectResponse');
46 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
47 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
48 class_has _result_key => (isa => 'Str', is => 'ro');
49 class_has _stream_param => (is => 'ro', default => 'Body');
50
51 1;
52  
53 ### main pod documentation begin ###
54  
55 =head1 NAME
56  
57 Paws::S3::WriteGetObjectResponse - Arguments for method WriteGetObjectResponse on L<Paws::S3>
58  
59 =head1 DESCRIPTION
60  
61 This class represents the parameters used for calling the method WriteGetObjectResponse on the
62 L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class
63 as arguments to method WriteGetObjectResponse.
64  
65 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to WriteGetObjectResponse.
66  
67 =head1 SYNOPSIS
68  
69 my $s3 = Paws->service('S3');
70 $s3->WriteGetObjectResponse(
71 RequestRoute => 'MyRequestRoute',
72 RequestToken => 'MyRequestToken',
73 AcceptRanges => 'MyAcceptRanges', # OPTIONAL
74 Body => 'BlobBody', # OPTIONAL
75 BucketKeyEnabled => 1, # OPTIONAL
76 CacheControl => 'MyCacheControl', # OPTIONAL
77 ContentDisposition => 'MyContentDisposition', # OPTIONAL
78 ContentEncoding => 'MyContentEncoding', # OPTIONAL
79 ContentLanguage => 'MyContentLanguage', # OPTIONAL
80 ContentLength => 1, # OPTIONAL
81 ContentRange => 'MyContentRange', # OPTIONAL
82 ContentType => 'MyContentType', # OPTIONAL
83 DeleteMarker => 1, # OPTIONAL
84 ETag => 'MyETag', # OPTIONAL
85 ErrorCode => 'MyErrorCode', # OPTIONAL
86 ErrorMessage => 'MyErrorMessage', # OPTIONAL
87 Expiration => 'MyExpiration', # OPTIONAL
88 Expires => '1970-01-01T01:00:00', # OPTIONAL
89 LastModified => '1970-01-01T01:00:00', # OPTIONAL
90 Metadata => { 'MyMetadataKey' => 'MyMetadataValue', }, # OPTIONAL
91 MissingMeta => 1, # OPTIONAL
92 ObjectLockLegalHoldStatus => 'ON', # OPTIONAL
93 ObjectLockMode => 'GOVERNANCE', # OPTIONAL
94 ObjectLockRetainUntilDate => '1970-01-01T01:00:00', # OPTIONAL
95 PartsCount => 1, # OPTIONAL
96 ReplicationStatus => 'COMPLETE', # OPTIONAL
97 RequestCharged => 'requester', # OPTIONAL
98 Restore => 'MyRestore', # OPTIONAL
99 SSECustomerAlgorithm => 'MySSECustomerAlgorithm', # OPTIONAL
100 SSECustomerKeyMD5 => 'MySSECustomerKeyMD5', # OPTIONAL
101 SSEKMSKeyId => 'MySSEKMSKeyId', # OPTIONAL
102 ServerSideEncryption => 'AES256', # OPTIONAL
103 StatusCode => 1, # OPTIONAL
104 StorageClass => 'STANDARD', # OPTIONAL
105 TagCount => 1, # OPTIONAL
106 VersionId => 'MyObjectVersionId', # OPTIONAL
107 );
108  
109 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.
110 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/WriteGetObjectResponse>
111  
112 =head1 ATTRIBUTES
113  
114  
115 =head2 AcceptRanges => Str
116  
117 Indicates that a range of bytes was specified.
118  
119  
120  
121 =head2 Body => Str
122  
123 The object data.
124  
125  
126  
127 =head2 BucketKeyEnabled => Bool
128  
129 Indicates whether the object stored in Amazon S3 uses an S3 bucket key
130 for server-side encryption with AWS KMS (SSE-KMS).
131  
132  
133  
134 =head2 CacheControl => Str
135  
136 Specifies caching behavior along the request/reply chain.
137  
138  
139  
140 =head2 ContentDisposition => Str
141  
142 Specifies presentational information for the object.
143  
144  
145  
146 =head2 ContentEncoding => Str
147  
148 Specifies what content encodings have been applied to the object and
149 thus what decoding mechanisms must be applied to obtain the media-type
150 referenced by the Content-Type header field.
151  
152  
153  
154 =head2 ContentLanguage => Str
155  
156 The language the content is in.
157  
158  
159  
160 =head2 ContentLength => Int
161  
162 The size of the content body in bytes.
163  
164  
165  
166 =head2 ContentRange => Str
167  
168 The portion of the object returned in the response.
169  
170  
171  
172 =head2 ContentType => Str
173  
174 A standard MIME type describing the format of the object data.
175  
176  
177  
178 =head2 DeleteMarker => Bool
179  
180 Specifies whether an object stored in Amazon S3 is (C<true>) or is not
181 (C<false>) a delete marker.
182  
183  
184  
185 =head2 ErrorCode => Str
186  
187 A string that uniquely identifies an error condition. Returned in the
188 E<lt>CodeE<gt> tag of the error XML response for a corresponding
189 C<GetObject> call. Cannot be used with a successful C<StatusCode>
190 header or when the transformed object is provided in the body. All
191 error codes from S3 are sentence-cased. Regex value is
192 "^[A-Z][a-zA-Z]+$".
193  
194  
195  
196 =head2 ErrorMessage => Str
197  
198 Contains a generic description of the error condition. Returned in the
199 E<lt>MessageE<gt> tag of the error XML response for a corresponding
200 C<GetObject> call. Cannot be used with a successful C<StatusCode>
201 header or when the transformed object is provided in body.
202  
203  
204  
205 =head2 ETag => Str
206  
207 An opaque identifier assigned by a web server to a specific version of
208 a resource found at a URL.
209  
210  
211  
212 =head2 Expiration => Str
213  
214 If object stored in Amazon S3 expiration is configured (see PUT Bucket
215 lifecycle) it includes expiry-date and rule-id key-value pairs
216 providing object expiration information. The value of the rule-id is
217 URL encoded.
218  
219  
220  
221 =head2 Expires => Str
222  
223 The date and time at which the object is no longer cacheable.
224  
225  
226  
227 =head2 LastModified => Str
228  
229 The date and time that the object was last modified.
230  
231  
232  
233 =head2 Metadata => L<Paws::S3::Metadata>
234  
235 A map of metadata to store with the object in S3.
236  
237  
238  
239 =head2 MissingMeta => Int
240  
241 Set to the number of metadata entries not returned in C<x-amz-meta>
242 headers. This can happen if you create metadata using an API like SOAP
243 that supports more flexible metadata than the REST API. For example,
244 using SOAP, you can create metadata whose values are not legal HTTP
245 headers.
246  
247  
248  
249 =head2 ObjectLockLegalHoldStatus => Str
250  
251 Indicates whether an object stored in Amazon S3 has an active legal
252 hold.
253  
254 Valid values are: C<"ON">, C<"OFF">
255  
256 =head2 ObjectLockMode => Str
257  
258 Indicates whether an object stored in Amazon S3 has Object Lock
259 enabled. For more information about S3 Object Lock, see Object Lock
260 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html).
261  
262 Valid values are: C<"GOVERNANCE">, C<"COMPLIANCE">
263  
264 =head2 ObjectLockRetainUntilDate => Str
265  
266 The date and time when Object Lock is configured to expire.
267  
268  
269  
270 =head2 PartsCount => Int
271  
272 The count of parts this object has.
273  
274  
275  
276 =head2 ReplicationStatus => Str
277  
278 Indicates if request involves bucket that is either a source or
279 destination in a Replication rule. For more information about S3
280 Replication, see Replication
281 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html).
282  
283 Valid values are: C<"COMPLETE">, C<"PENDING">, C<"FAILED">, C<"REPLICA">
284  
285 =head2 RequestCharged => Str
286  
287  
288  
289 Valid values are: C<"requester">
290  
291 =head2 B<REQUIRED> RequestRoute => Str
292  
293 Route prefix to the HTTP URL generated.
294  
295  
296  
297 =head2 B<REQUIRED> RequestToken => Str
298  
299 A single use encrypted token that maps C<WriteGetObjectResponse> to the
300 end user C<GetObject> request.
301  
302  
303  
304 =head2 Restore => Str
305  
306 Provides information about object restoration operation and expiration
307 time of the restored object copy.
308  
309  
310  
311 =head2 ServerSideEncryption => Str
312  
313 The server-side encryption algorithm used when storing requested object
314 in Amazon S3 (for example, AES256, aws:kms).
315  
316 Valid values are: C<"AES256">, C<"aws:kms">
317  
318 =head2 SSECustomerAlgorithm => Str
319  
320 Encryption algorithm used if server-side encryption with a
321 customer-provided encryption key was specified for object stored in
322 Amazon S3.
323  
324  
325  
326 =head2 SSECustomerKeyMD5 => Str
327  
328 128-bit MD5 digest of customer-provided encryption key used in Amazon
329 S3 to encrypt data stored in S3. For more information, see Protecting
330 data using server-side encryption with customer-provided encryption
331 keys (SSE-C)
332 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html).
333  
334  
335  
336 =head2 SSEKMSKeyId => Str
337  
338 If present, specifies the ID of the AWS Key Management Service (AWS
339 KMS) symmetric customer managed customer master key (CMK) that was used
340 for stored in Amazon S3 object.
341  
342  
343  
344 =head2 StatusCode => Int
345  
346 The integer status code for an HTTP response of a corresponding
347 C<GetObject> request.
348  
349 B<Status Codes>
350  
351 =over
352  
353 =item *
354  
355 I<200 - OK>
356  
357 =item *
358  
359 I<206 - Partial Content>
360  
361 =item *
362  
363 I<304 - Not Modified>
364  
365 =item *
366  
367 I<400 - Bad Request>
368  
369 =item *
370  
371 I<401 - Unauthorized>
372  
373 =item *
374  
375 I<403 - Forbidden>
376  
377 =item *
378  
379 I<404 - Not Found>
380  
381 =item *
382  
383 I<405 - Method Not Allowed>
384  
385 =item *
386  
387 I<409 - Conflict>
388  
389 =item *
390  
391 I<411 - Length Required>
392  
393 =item *
394  
395 I<412 - Precondition Failed>
396  
397 =item *
398  
399 I<416 - Range Not Satisfiable>
400  
401 =item *
402  
403 I<500 - Internal Server Error>
404  
405 =item *
406  
407 I<503 - Service Unavailable>
408  
409 =back
410  
411  
412  
413  
414 =head2 StorageClass => Str
415  
416 The class of storage used to store object in Amazon S3.
417  
418 Valid values are: C<"STANDARD">, C<"REDUCED_REDUNDANCY">, C<"STANDARD_IA">, C<"ONEZONE_IA">, C<"INTELLIGENT_TIERING">, C<"GLACIER">, C<"DEEP_ARCHIVE">, C<"OUTPOSTS">
419  
420 =head2 TagCount => Int
421  
422 The number of tags, if any, on the object.
423  
424  
425  
426 =head2 VersionId => Str
427  
428 An ID used to reference a specific version of the object.
429  
430  
431  
432  
433 =head1 SEE ALSO
434  
435 This class forms part of L<Paws>, documenting arguments for method WriteGetObjectResponse in L<Paws::S3>
436  
437 =head1 BUGS and CONTRIBUTIONS
438  
439 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
440  
441 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
442  
443 =cut
444