File Coverage

blib/lib/Paws/S3/ListObjectsV2.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::S3::ListObjectsV2;
3 1     1   277 use Moose;
  1     3   1  
  1         7  
  3         1350  
  3         7  
  3         22  
4             has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1);
5             has ContinuationToken => (is => 'ro', isa => 'Str', query_name => 'continuation-token', traits => ['ParamInQuery']);
6             has Delimiter => (is => 'ro', isa => 'Str', query_name => 'delimiter', traits => ['ParamInQuery']);
7             has EncodingType => (is => 'ro', isa => 'Str', query_name => 'encoding-type', traits => ['ParamInQuery']);
8             has FetchOwner => (is => 'ro', isa => 'Bool', query_name => 'fetch-owner', traits => ['ParamInQuery']);
9             has MaxKeys => (is => 'ro', isa => 'Int', query_name => 'max-keys', traits => ['ParamInQuery']);
10             has Prefix => (is => 'ro', isa => 'Str', query_name => 'prefix', traits => ['ParamInQuery']);
11             has RequestPayer => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-payer', traits => ['ParamInHeader']);
12             has StartAfter => (is => 'ro', isa => 'Str', query_name => 'start-after', traits => ['ParamInQuery']);
13              
14 1     1   5370 use MooseX::ClassAttribute;
  1     3   3  
  1         7  
  3         18327  
  3         5  
  3         24  
15              
16             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListObjectsV2');
17             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}?list-type=2');
18             class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
19             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::ListObjectsV2Output');
20             class_has _result_key => (isa => 'Str', is => 'ro');
21            
22             1;
23              
24             ### main pod documentation begin ###
25              
26             =head1 NAME
27              
28             Paws::S3::ListObjectsV2 - Arguments for method ListObjectsV2 on Paws::S3
29              
30             =head1 DESCRIPTION
31              
32             This class represents the parameters used for calling the method ListObjectsV2 on the
33             Amazon Simple Storage Service service. Use the attributes of this class
34             as arguments to method ListObjectsV2.
35              
36             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListObjectsV2.
37              
38             As an example:
39              
40             $service_obj->ListObjectsV2(Att1 => $value1, Att2 => $value2, ...);
41              
42             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.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 B<REQUIRED> Bucket => Str
48              
49             Name of the bucket to list.
50              
51              
52              
53             =head2 ContinuationToken => Str
54              
55             ContinuationToken indicates Amazon S3 that the list is being continued
56             on this bucket with a token. ContinuationToken is obfuscated and is not
57             a real key
58              
59              
60              
61             =head2 Delimiter => Str
62              
63             A delimiter is a character you use to group keys.
64              
65              
66              
67             =head2 EncodingType => Str
68              
69             Encoding type used by Amazon S3 to encode object keys in the response.
70              
71             Valid values are: C<"url">
72              
73             =head2 FetchOwner => Bool
74              
75             The owner field is not present in listV2 by default, if you want to
76             return owner field with each key in the result then set the fetch owner
77             field to true
78              
79              
80              
81             =head2 MaxKeys => Int
82              
83             Sets the maximum number of keys returned in the response. The response
84             might contain fewer keys but will never contain more.
85              
86              
87              
88             =head2 Prefix => Str
89              
90             Limits the response to keys that begin with the specified prefix.
91              
92              
93              
94             =head2 RequestPayer => Str
95              
96             Confirms that the requester knows that she or he will be charged for
97             the list objects request in V2 style. Bucket owners need not specify
98             this parameter in their requests.
99              
100             Valid values are: C<"requester">
101              
102             =head2 StartAfter => Str
103              
104             StartAfter is where you want Amazon S3 to start listing from. Amazon S3
105             starts listing after this specified key. StartAfter can be any key in
106             the bucket
107              
108              
109              
110              
111             =head1 SEE ALSO
112              
113             This class forms part of L<Paws>, documenting arguments for method ListObjectsV2 in L<Paws::S3>
114              
115             =head1 BUGS and CONTRIBUTIONS
116              
117             The source code is located here: https://github.com/pplu/aws-sdk-perl
118              
119             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
120              
121             =cut
122