Interface ListObjectsV2Response.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<ListObjectsV2Response.Builder,
,ListObjectsV2Response> S3Response.Builder
,SdkBuilder<ListObjectsV2Response.Builder,
,ListObjectsV2Response> SdkPojo
,SdkResponse.Builder
- Enclosing class:
ListObjectsV2Response
-
Method Summary
Modifier and TypeMethodDescriptioncommonPrefixes
(Collection<CommonPrefix> commonPrefixes) All of the keys (up to 1,000) that share the same prefix are grouped together.commonPrefixes
(Consumer<CommonPrefix.Builder>... commonPrefixes) All of the keys (up to 1,000) that share the same prefix are grouped together.commonPrefixes
(CommonPrefix... commonPrefixes) All of the keys (up to 1,000) that share the same prefix are grouped together.contents
(Collection<S3Object> contents) Metadata about each object returned.contents
(Consumer<S3Object.Builder>... contents) Metadata about each object returned.Metadata about each object returned.continuationToken
(String continuationToken) IfContinuationToken
was sent with the request, it is included in the response.Causes keys that contain the same string between theprefix
and the first occurrence of the delimiter to be rolled up into a single result element in theCommonPrefixes
collection.encodingType
(String encodingType) Encoding type used by Amazon S3 to encode object key names in the XML response.encodingType
(EncodingType encodingType) Encoding type used by Amazon S3 to encode object key names in the XML response.isTruncated
(Boolean isTruncated) Set tofalse
if all of the results were returned.KeyCount
is the number of keys returned with this request.Sets the maximum number of keys returned in the response.The bucket name.nextContinuationToken
(String nextContinuationToken) NextContinuationToken
is sent whenisTruncated
is true, which means there are more keys in the bucket that can be listed.Keys that begin with the indicated prefix.requestCharged
(String requestCharged) Sets the value of the RequestCharged property for this object.requestCharged
(RequestCharged requestCharged) Sets the value of the RequestCharged property for this object.startAfter
(String startAfter) If StartAfter was sent with the request, it is included in the response.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Response.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
isTruncated
Set to
false
if all of the results were returned. Set totrue
if more keys are available to return. If the number of results exceeds that specified byMaxKeys
, all of the results might not be returned.- Parameters:
isTruncated
- Set tofalse
if all of the results were returned. Set totrue
if more keys are available to return. If the number of results exceeds that specified byMaxKeys
, all of the results might not be returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contents
Metadata about each object returned.
- Parameters:
contents
- Metadata about each object returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contents
Metadata about each object returned.
- Parameters:
contents
- Metadata about each object returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contents
Metadata about each object returned.
This is a convenience method that creates an instance of theS3Object.Builder
avoiding the need to create one manually viaS3Object.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocontents(List<S3Object>)
.- Parameters:
contents
- a consumer that will call methods onS3Object.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
The bucket name.
- Parameters:
name
- The bucket name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
prefix
Keys that begin with the indicated prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.- Parameters:
prefix
- Keys that begin with the indicated prefix.Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
delimiter
Causes keys that contain the same string between the
prefix
and the first occurrence of the delimiter to be rolled up into a single result element in theCommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against theMaxKeys
value.Directory buckets - For directory buckets,
/
is the only supported delimiter.- Parameters:
delimiter
- Causes keys that contain the same string between theprefix
and the first occurrence of the delimiter to be rolled up into a single result element in theCommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against theMaxKeys
value.Directory buckets - For directory buckets,
/
is the only supported delimiter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxKeys
Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
- Parameters:
maxKeys
- Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commonPrefixes
All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.
A response can contain
CommonPrefixes
only if you specify a delimiter.CommonPrefixes
contains all (if there are any) keys betweenPrefix
and the next occurrence of the string specified by a delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
) as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.-
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported. -
Directory buckets - When you query
ListObjectsV2
with a delimiter during in-progress multipart uploads, theCommonPrefixes
response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
- Parameters:
commonPrefixes
- All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.A response can contain
CommonPrefixes
only if you specify a delimiter.CommonPrefixes
contains all (if there are any) keys betweenPrefix
and the next occurrence of the string specified by a delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
) as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.-
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported. -
Directory buckets - When you query
ListObjectsV2
with a delimiter during in-progress multipart uploads, theCommonPrefixes
response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
commonPrefixes
All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.
A response can contain
CommonPrefixes
only if you specify a delimiter.CommonPrefixes
contains all (if there are any) keys betweenPrefix
and the next occurrence of the string specified by a delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
) as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.-
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported. -
Directory buckets - When you query
ListObjectsV2
with a delimiter during in-progress multipart uploads, theCommonPrefixes
response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
- Parameters:
commonPrefixes
- All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.A response can contain
CommonPrefixes
only if you specify a delimiter.CommonPrefixes
contains all (if there are any) keys betweenPrefix
and the next occurrence of the string specified by a delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
) as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.-
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported. -
Directory buckets - When you query
ListObjectsV2
with a delimiter during in-progress multipart uploads, theCommonPrefixes
response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
commonPrefixes
All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.
A response can contain
CommonPrefixes
only if you specify a delimiter.CommonPrefixes
contains all (if there are any) keys betweenPrefix
and the next occurrence of the string specified by a delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
) as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.-
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported. -
Directory buckets - When you query
ListObjectsV2
with a delimiter during in-progress multipart uploads, theCommonPrefixes
response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
CommonPrefix.Builder
avoiding the need to create one manually viaCommonPrefix.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocommonPrefixes(List<CommonPrefix>)
.- Parameters:
commonPrefixes
- a consumer that will call methods onCommonPrefix.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
encodingType
Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify the
encoding-type
request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:Delimiter, Prefix, Key,
andStartAfter
.- Parameters:
encodingType
- Encoding type used by Amazon S3 to encode object key names in the XML response.If you specify the
encoding-type
request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:Delimiter, Prefix, Key,
andStartAfter
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
encodingType
Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify the
encoding-type
request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:Delimiter, Prefix, Key,
andStartAfter
.- Parameters:
encodingType
- Encoding type used by Amazon S3 to encode object key names in the XML response.If you specify the
encoding-type
request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:Delimiter, Prefix, Key,
andStartAfter
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keyCount
KeyCount
is the number of keys returned with this request.KeyCount
will always be less than or equal to theMaxKeys
field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.- Parameters:
keyCount
-KeyCount
is the number of keys returned with this request.KeyCount
will always be less than or equal to theMaxKeys
field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
continuationToken
If
ContinuationToken
was sent with the request, it is included in the response. You can use the returnedContinuationToken
for pagination of the list response. You can use thisContinuationToken
for pagination of the list results.- Parameters:
continuationToken
- IfContinuationToken
was sent with the request, it is included in the response. You can use the returnedContinuationToken
for pagination of the list response. You can use thisContinuationToken
for pagination of the list results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextContinuationToken
NextContinuationToken
is sent whenisTruncated
is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with thisNextContinuationToken
.NextContinuationToken
is obfuscated and is not a real key- Parameters:
nextContinuationToken
-NextContinuationToken
is sent whenisTruncated
is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with thisNextContinuationToken
.NextContinuationToken
is obfuscated and is not a real key- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startAfter
If StartAfter was sent with the request, it is included in the response.
This functionality is not supported for directory buckets.
- Parameters:
startAfter
- If StartAfter was sent with the request, it is included in the response.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestCharged
Sets the value of the RequestCharged property for this object.- Parameters:
requestCharged
- The new value for the RequestCharged property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
requestCharged
Sets the value of the RequestCharged property for this object.- Parameters:
requestCharged
- The new value for the RequestCharged property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-