| 1 | |||
| 2 | package Paws::S3::ListObjectsOutput; | ||
| 3 | 3 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 3 | has CommonPrefixes => (is => 'ro', isa => 'ArrayRef[Paws::S3::CommonPrefix]'); | |
| 5 | 3 | has Contents => (is => 'ro', isa => 'ArrayRef[Paws::S3::Object]'); | |
| 6 | 3 | has Delimiter => (is => 'ro', isa => 'Str'); | |
| 7 | 3 | has EncodingType => (is => 'ro', isa => 'Str'); | |
| 8 | 3 | has IsTruncated => (is => 'ro', isa => 'Bool'); | |
| 9 | 3 | has Marker => (is => 'ro', isa => 'Str'); | |
| 10 | 3 | has MaxKeys => (is => 'ro', isa => 'Int'); | |
| 11 | 3 | has Name => (is => 'ro', isa => 'Str'); | |
| 12 | 3 | has NextMarker => (is => 'ro', isa => 'Str'); | |
| 13 | 3 | has Prefix => (is => 'ro', isa => 'Str'); | |
| 14 | |||
| 15 | |||
| 16 | 3 | has _request_id => (is => 'ro', isa => 'Str'); | |
| 17 | 3 | 1; | |
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::S3::ListObjectsOutput | ||
| 24 | |||
| 25 | =head1 ATTRIBUTES | ||
| 26 | |||
| 27 | |||
| 28 | =head2 CommonPrefixes => ArrayRef[L<Paws::S3::CommonPrefix>] | ||
| 29 | |||
| 30 | All of the keys (up to 1,000) rolled up in a common prefix count as a | ||
| 31 | single return when calculating the number of returns. | ||
| 32 | |||
| 33 | A response can contain CommonPrefixes only if you specify a delimiter. | ||
| 34 | |||
| 35 | CommonPrefixes contains all (if there are any) keys between Prefix and | ||
| 36 | the next occurrence of the string specified by the delimiter. | ||
| 37 | |||
| 38 | CommonPrefixes lists keys that act like subdirectories in the directory | ||
| 39 | specified by Prefix. | ||
| 40 | |||
| 41 | For example, if the prefix is notes/ and the delimiter is a slash (/) | ||
| 42 | as in notes/summer/july, the common prefix is notes/summer/. All of the | ||
| 43 | keys that roll up into a common prefix count as a single return when | ||
| 44 | calculating the number of returns. | ||
| 45 | |||
| 46 | |||
| 47 | |||
| 48 | =head2 Contents => ArrayRef[L<Paws::S3::Object>] | ||
| 49 | |||
| 50 | Metadata about each object returned. | ||
| 51 | |||
| 52 | |||
| 53 | |||
| 54 | =head2 Delimiter => Str | ||
| 55 | |||
| 56 | Causes keys that contain the same string between the prefix and the | ||
| 57 | first occurrence of the delimiter to be rolled up into a single result | ||
| 58 | element in the C<CommonPrefixes> collection. These rolled-up keys are | ||
| 59 | not returned elsewhere in the response. Each rolled-up result counts as | ||
| 60 | only one return against the C<MaxKeys> value. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 EncodingType => Str | ||
| 65 | |||
| 66 | Encoding type used by Amazon S3 to encode object keys in the response. | ||
| 67 | |||
| 68 | Valid values are: C<"url"> | ||
| 69 | |||
| 70 | =head2 IsTruncated => Bool | ||
| 71 | |||
| 72 | A flag that indicates whether Amazon S3 returned all of the results | ||
| 73 | that satisfied the search criteria. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 Marker => Str | ||
| 78 | |||
| 79 | Indicates where in the bucket listing begins. Marker is included in the | ||
| 80 | response if it was sent with the request. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 MaxKeys => Int | ||
| 85 | |||
| 86 | The maximum number of keys returned in the response body. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 Name => Str | ||
| 91 | |||
| 92 | The bucket name. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 NextMarker => Str | ||
| 97 | |||
| 98 | When response is truncated (the IsTruncated element value in the | ||
| 99 | response is true), you can use the key name in this field as marker in | ||
| 100 | the subsequent request to get next set of objects. Amazon S3 lists | ||
| 101 | objects in alphabetical order Note: This element is returned only if | ||
| 102 | you have delimiter request parameter specified. If response does not | ||
| 103 | include the NextMarker and it is truncated, you can use the value of | ||
| 104 | the last Key in the response as the marker in the subsequent request to | ||
| 105 | get the next set of object keys. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 Prefix => Str | ||
| 110 | |||
| 111 | Keys that begin with the indicated prefix. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =cut | ||
| 117 | |||