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) rolled up into a common prefix count as a single return when calculating the
number of returns.
|
ListObjectsV2Response.Builder |
commonPrefixes(CommonPrefix... commonPrefixes)
All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the
number of returns.
|
ListObjectsV2Response.Builder |
commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes)
All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the
number of returns.
|
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 |
startAfter(String startAfter)
If StartAfter was sent with the request, it is included in the response.
|
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
ListObjectsV2Response.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 theList.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #contents(List)
.contents
- a consumer that will call methods on List.Builder
#contents(List)
ListObjectsV2Response.Builder name(String name)
The bucket name.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname.
The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on
Outposts in the Amazon S3 User Guide.
name
- The bucket name.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on
Outposts in the Amazon S3 User Guide.
ListObjectsV2Response.Builder prefix(String prefix)
Keys that begin with the indicated prefix.
prefix
- Keys that begin with the indicated prefix.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.
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.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) rolled up into a common prefix count as a single return when calculating the number of returns.
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.
commonPrefixes
- All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating
the number of returns.
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.
ListObjectsV2Response.Builder commonPrefixes(CommonPrefix... commonPrefixes)
All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.
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.
commonPrefixes
- All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating
the number of returns.
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.
ListObjectsV2Response.Builder commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes)
All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.
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.
List.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #commonPrefixes(List)
.commonPrefixes
- a consumer that will call methods on List.Builder
#commonPrefixes(List)
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
,
EncodingType
ListObjectsV2Response.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
,
EncodingType
ListObjectsV2Response.Builder keyCount(Integer keyCount)
KeyCount is the number of keys returned with this request. KeyCount will always be less than or equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
keyCount
- KeyCount is the number of keys returned with this request. KeyCount will always be less than or equals
to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keysListObjectsV2Response.Builder continuationToken(String continuationToken)
If ContinuationToken was sent with the request, it is included in the response.
continuationToken
- If ContinuationToken was sent with the request, it is included in the response.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.
startAfter
- If StartAfter was sent with the request, it is included in the response.Copyright © 2022. All rights reserved.