@Mutable @NotThreadSafe public static interface ListObjectsV2Response.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<ListObjectsV2Response.Builder,ListObjectsV2Response>
| Modifier and Type | Method and Description |
|---|---|
ListObjectsV2Response.Builder |
commonPrefixes(Collection<CommonPrefix> commonPrefixes)
All of the keys (up to 1,000) that share the same prefix are grouped together.
|
ListObjectsV2Response.Builder |
commonPrefixes(CommonPrefix... commonPrefixes)
All of the keys (up to 1,000) that share the same prefix are grouped together.
|
ListObjectsV2Response.Builder |
commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes)
All of the keys (up to 1,000) that share the same prefix are grouped together.
|
ListObjectsV2Response.Builder |
contents(Collection<S3Object> contents)
Metadata about each object returned.
|
ListObjectsV2Response.Builder |
contents(Consumer<S3Object.Builder>... contents)
Metadata about each object returned.
|
ListObjectsV2Response.Builder |
contents(S3Object... contents)
Metadata about each object returned.
|
ListObjectsV2Response.Builder |
continuationToken(String continuationToken)
If
ContinuationToken was sent with the request, it is included in the response. |
ListObjectsV2Response.Builder |
delimiter(String 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 the CommonPrefixes collection. |
ListObjectsV2Response.Builder |
encodingType(EncodingType encodingType)
Encoding type used by Amazon S3 to encode object key names in the XML response.
|
ListObjectsV2Response.Builder |
encodingType(String encodingType)
Encoding type used by Amazon S3 to encode object key names in the XML response.
|
ListObjectsV2Response.Builder |
isTruncated(Boolean isTruncated)
Set to
false if all of the results were returned. |
ListObjectsV2Response.Builder |
keyCount(Integer keyCount)
KeyCount is the number of keys returned with this request. |
ListObjectsV2Response.Builder |
maxKeys(Integer maxKeys)
Sets the maximum number of keys returned in the response.
|
ListObjectsV2Response.Builder |
name(String name)
The bucket name.
|
ListObjectsV2Response.Builder |
nextContinuationToken(String nextContinuationToken)
NextContinuationToken is sent when isTruncated is true, which means there are more
keys in the bucket that can be listed. |
ListObjectsV2Response.Builder |
prefix(String prefix)
Keys that begin with the indicated prefix.
|
ListObjectsV2Response.Builder |
requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.
|
ListObjectsV2Response.Builder |
requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.
|
ListObjectsV2Response.Builder |
startAfter(String startAfter)
If StartAfter was sent with the request, it is included in the response.
|
build, responseMetadata, responseMetadatasdkHttpResponse, sdkHttpResponseequalsBySdkFields, sdkFieldNameToField, sdkFieldscopyapplyMutation, buildListObjectsV2Response.Builder isTruncated(Boolean isTruncated)
Set to false if all of the results were returned. Set to true if more keys are
available to return. If the number of results exceeds that specified by MaxKeys, all of the
results might not be returned.
isTruncated - Set to false if all of the results were returned. Set to true if more keys
are available to return. If the number of results exceeds that specified by MaxKeys, all
of the results might not be returned.ListObjectsV2Response.Builder contents(Collection<S3Object> contents)
Metadata about each object returned.
contents - Metadata about each object returned.ListObjectsV2Response.Builder contents(S3Object... contents)
Metadata about each object returned.
contents - Metadata about each object returned.ListObjectsV2Response.Builder contents(Consumer<S3Object.Builder>... 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
via S3Object.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to #contents(List.
contents - a consumer that will call methods on S3Object.Builder#contents(java.util.Collection) ListObjectsV2Response.Builder name(String name)
The bucket name.
name - The bucket name.ListObjectsV2Response.Builder prefix(String prefix)
Keys that begin with the indicated prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are
supported.
prefix - Keys that begin with the indicated prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/) are supported.
ListObjectsV2Response.Builder delimiter(String 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 the CommonPrefixes collection. These
rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return
against the MaxKeys value.
Directory buckets - For directory buckets, / is the only supported delimiter.
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 the CommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result
counts as only one return against the MaxKeys value.
Directory buckets - For directory buckets, / is the only supported delimiter.
ListObjectsV2Response.Builder maxKeys(Integer 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.
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.ListObjectsV2Response.Builder commonPrefixes(Collection<CommonPrefix> 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 between Prefix and the next
occurrence of the string specified by a delimiter.
CommonPrefixes lists keys that act like subdirectories in the directory specified by
Prefix.
For example, if the prefix is notes/ and the delimiter is a slash (/) as in
notes/summer/july, the common prefix is notes/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, the CommonPrefixes 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.
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 between Prefix and the
next occurrence of the string specified by a delimiter.
CommonPrefixes lists keys that act like subdirectories in the directory specified by
Prefix.
For example, if the prefix is notes/ and the delimiter is a slash (/) as in
notes/summer/july, the common prefix is notes/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, the CommonPrefixes 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.
ListObjectsV2Response.Builder commonPrefixes(CommonPrefix... 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 between Prefix and the next
occurrence of the string specified by a delimiter.
CommonPrefixes lists keys that act like subdirectories in the directory specified by
Prefix.
For example, if the prefix is notes/ and the delimiter is a slash (/) as in
notes/summer/july, the common prefix is notes/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, the CommonPrefixes 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.
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 between Prefix and the
next occurrence of the string specified by a delimiter.
CommonPrefixes lists keys that act like subdirectories in the directory specified by
Prefix.
For example, if the prefix is notes/ and the delimiter is a slash (/) as in
notes/summer/july, the common prefix is notes/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, the CommonPrefixes 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.
ListObjectsV2Response.Builder commonPrefixes(Consumer<CommonPrefix.Builder>... 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 between Prefix and the next
occurrence of the string specified by a delimiter.
CommonPrefixes lists keys that act like subdirectories in the directory specified by
Prefix.
For example, if the prefix is notes/ and the delimiter is a slash (/) as in
notes/summer/july, the common prefix is notes/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, the CommonPrefixes 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 via CommonPrefix.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to #commonPrefixes(List.
commonPrefixes - a consumer that will call methods on
CommonPrefix.Builder#commonPrefixes(java.util.Collection) ListObjectsV2Response.Builder encodingType(String 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, and StartAfter.
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, and StartAfter.
EncodingType,
EncodingTypeListObjectsV2Response.Builder encodingType(EncodingType 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, and StartAfter.
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, and StartAfter.
EncodingType,
EncodingTypeListObjectsV2Response.Builder keyCount(Integer keyCount)
KeyCount is the number of keys returned with this request. KeyCount will always be
less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will
include 50 keys or fewer.
keyCount - KeyCount is the number of keys returned with this request. KeyCount will
always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys,
your result will include 50 keys or fewer.ListObjectsV2Response.Builder continuationToken(String continuationToken)
If ContinuationToken was sent with the request, it is included in the response. You can use the
returned ContinuationToken for pagination of the list response. You can use this
ContinuationToken for pagination of the list results.
continuationToken - If ContinuationToken was sent with the request, it is included in the response. You can
use the returned ContinuationToken for pagination of the list response. You can use this
ContinuationToken for pagination of the list results.ListObjectsV2Response.Builder nextContinuationToken(String nextContinuationToken)
NextContinuationToken is sent when isTruncated 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 this
NextContinuationToken. NextContinuationToken is obfuscated and is not a real key
nextContinuationToken - NextContinuationToken is sent when isTruncated 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 this NextContinuationToken. NextContinuationToken is obfuscated and is
not a real keyListObjectsV2Response.Builder startAfter(String startAfter)
If StartAfter was sent with the request, it is included in the response.
This functionality is not supported for directory buckets.
startAfter - If StartAfter was sent with the request, it is included in the response. This functionality is not supported for directory buckets.
ListObjectsV2Response.Builder requestCharged(String requestCharged)
requestCharged - The new value for the RequestCharged property for this object.RequestCharged,
RequestChargedListObjectsV2Response.Builder requestCharged(RequestCharged requestCharged)
requestCharged - The new value for the RequestCharged property for this object.RequestCharged,
RequestChargedCopyright © 2026. All rights reserved.