blib/lib/Paws/S3/ListObjectsV2Output.pm

filter: Statementstmt 100% 17 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 1 / 1 Podpod n/a totaltotal 100% 18 / 18 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/S3/ListObjectsV2.pm ↑ Summary blib/lib/Paws/S3/ListParts.pm »
1  
2 package Paws::S3::ListObjectsV2Output;
3 2 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 2 has CommonPrefixes => (is => 'ro', isa => 'ArrayRef[Paws::S3::CommonPrefix]');
5 2 has Contents => (is => 'ro', isa => 'ArrayRef[Paws::S3::Object]');
6 2 has ContinuationToken => (is => 'ro', isa => 'Str');
7 2 has Delimiter => (is => 'ro', isa => 'Str');
8 2 has EncodingType => (is => 'ro', isa => 'Str');
9 2 has IsTruncated => (is => 'ro', isa => 'Bool');
10 2 has KeyCount => (is => 'ro', isa => 'Int');
11 2 has MaxKeys => (is => 'ro', isa => 'Int');
12 2 has Name => (is => 'ro', isa => 'Str');
13 2 has NextContinuationToken => (is => 'ro', isa => 'Str');
14 2 has Prefix => (is => 'ro', isa => 'Str');
15 2 has StartAfter => (is => 'ro', isa => 'Str');
16  
17  
18 2 has _request_id => (is => 'ro', isa => 'Str');
19 2 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::S3::ListObjectsV2Output
26  
27 =head1 ATTRIBUTES
28  
29  
30 =head2 CommonPrefixes => ArrayRef[L<Paws::S3::CommonPrefix>]
31  
32 All of the keys (up to 1,000) rolled up into a common prefix count as a
33 single return when calculating the number of returns.
34  
35 A response can contain C<CommonPrefixes> only if you specify a
36 delimiter.
37  
38 C<CommonPrefixes> contains all (if there are any) keys between
39 C<Prefix> and the next occurrence of the string specified by a
40 delimiter.
41  
42 C<CommonPrefixes> lists keys that act like subdirectories in the
43 directory specified by C<Prefix>.
44  
45 For example, if the prefix is C<notes/> and the delimiter is a slash
46 (C</>) as in C<notes/summer/july>, the common prefix is
47 C<notes/summer/>. All of the keys that roll up into a common prefix
48 count as a single return when calculating the number of returns.
49  
50  
51  
52 =head2 Contents => ArrayRef[L<Paws::S3::Object>]
53  
54 Metadata about each object returned.
55  
56  
57  
58 =head2 ContinuationToken => Str
59  
60 If ContinuationToken was sent with the request, it is included in the
61 response.
62  
63  
64  
65 =head2 Delimiter => Str
66  
67 Causes keys that contain the same string between the prefix and the
68 first occurrence of the delimiter to be rolled up into a single result
69 element in the CommonPrefixes collection. These rolled-up keys are not
70 returned elsewhere in the response. Each rolled-up result counts as
71 only one return against the C<MaxKeys> value.
72  
73  
74  
75 =head2 EncodingType => Str
76  
77 Encoding type used by Amazon S3 to encode object key names in the XML
78 response.
79  
80 If you specify the encoding-type request parameter, Amazon S3 includes
81 this element in the response, and returns encoded key name values in
82 the following response elements:
83  
84 C<Delimiter, Prefix, Key,> and C<StartAfter>.
85  
86 Valid values are: C<"url">
87  
88 =head2 IsTruncated => Bool
89  
90 Set to false if all of the results were returned. Set to true if more
91 keys are available to return. If the number of results exceeds that
92 specified by MaxKeys, all of the results might not be returned.
93  
94  
95  
96 =head2 KeyCount => Int
97  
98 KeyCount is the number of keys returned with this request. KeyCount
99 will always be less than or equals to MaxKeys field. Say you ask for 50
100 keys, your result will include less than equals 50 keys
101  
102  
103  
104 =head2 MaxKeys => Int
105  
106 Sets the maximum number of keys returned in the response. By default
107 the action returns up to 1,000 key names. The response might contain
108 fewer keys but will never contain more.
109  
110  
111  
112 =head2 Name => Str
113  
114 The bucket name.
115  
116 When using this action with an access point, you must direct requests
117 to the access point hostname. The access point hostname takes the form
118 I<AccessPointName>-I<AccountId>.s3-accesspoint.I<Region>.amazonaws.com.
119 When using this action with an access point through the AWS SDKs, you
120 provide the access point ARN in place of the bucket name. For more
121 information about access point ARNs, see Using access points
122 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
123 in the I<Amazon S3 User Guide>.
124  
125 When using this action with Amazon S3 on Outposts, you must direct
126 requests to the S3 on Outposts hostname. The S3 on Outposts hostname
127 takes the form
128 I<AccessPointName>-I<AccountId>.I<outpostID>.s3-outposts.I<Region>.amazonaws.com.
129 When using this action using S3 on Outposts through the AWS SDKs, you
130 provide the Outposts bucket ARN in place of the bucket name. For more
131 information about S3 on Outposts ARNs, see Using S3 on Outposts
132 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html)
133 in the I<Amazon S3 User Guide>.
134  
135  
136  
137 =head2 NextContinuationToken => Str
138  
139 C<NextContinuationToken> is sent when C<isTruncated> is true, which
140 means there are more keys in the bucket that can be listed. The next
141 list requests to Amazon S3 can be continued with this
142 C<NextContinuationToken>. C<NextContinuationToken> is obfuscated and is
143 not a real key
144  
145  
146  
147 =head2 Prefix => Str
148  
149 Keys that begin with the indicated prefix.
150  
151  
152  
153 =head2 StartAfter => Str
154  
155 If StartAfter was sent with the request, it is included in the
156 response.
157  
158  
159  
160  
161 =cut
162  
« blib/lib/Paws/S3/ListObjectsV2.pm ↑ Summary blib/lib/Paws/S3/ListParts.pm »