public static interface ListObjectsResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>
Modifier and Type | Method and Description |
---|---|
ListObjectsResponse.Builder |
commonPrefixes(Collection<CommonPrefix> commonPrefixes)
All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the
number of returns.
|
ListObjectsResponse.Builder |
commonPrefixes(CommonPrefix... commonPrefixes)
All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the
number of returns.
|
ListObjectsResponse.Builder |
commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes)
All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the
number of returns.
|
ListObjectsResponse.Builder |
contents(Collection<S3Object> contents)
Metadata about each object returned.
|
ListObjectsResponse.Builder |
contents(Consumer<S3Object.Builder>... contents)
Metadata about each object returned.
|
ListObjectsResponse.Builder |
contents(S3Object... contents)
Metadata about each object returned.
|
ListObjectsResponse.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. |
ListObjectsResponse.Builder |
encodingType(EncodingType encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.
|
ListObjectsResponse.Builder |
encodingType(String encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.
|
ListObjectsResponse.Builder |
isTruncated(Boolean isTruncated)
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
|
ListObjectsResponse.Builder |
marker(String marker)
Indicates where in the bucket listing begins.
|
ListObjectsResponse.Builder |
maxKeys(Integer maxKeys)
The maximum number of keys returned in the response body.
|
ListObjectsResponse.Builder |
name(String name)
The bucket name.
|
ListObjectsResponse.Builder |
nextMarker(String nextMarker)
When response is truncated (the IsTruncated element value in the response is true), you can use the key name
in this field as marker in the subsequent request to get next set of objects.
|
ListObjectsResponse.Builder |
prefix(String prefix)
Keys that begin with the indicated prefix.
|
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
ListObjectsResponse.Builder isTruncated(Boolean isTruncated)
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
isTruncated
- A flag that indicates whether Amazon S3 returned all of the results that satisfied the search
criteria.ListObjectsResponse.Builder marker(String marker)
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
marker
- Indicates where in the bucket listing begins. Marker is included in the response if it was sent with
the request.ListObjectsResponse.Builder nextMarker(String nextMarker)
When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMarker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.
nextMarker
- When response is truncated (the IsTruncated element value in the response is true), you can use the
key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists
objects in alphabetical order Note: This element is returned only if you have delimiter request
parameter specified. If response does not include the NextMarker and it is truncated, you can use the
value of the last Key in the response as the marker in the subsequent request to get the next set of
object keys.ListObjectsResponse.Builder contents(Collection<S3Object> contents)
Metadata about each object returned.
contents
- Metadata about each object returned.ListObjectsResponse.Builder contents(S3Object... contents)
Metadata about each object returned.
contents
- Metadata about each object returned.ListObjectsResponse.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)
ListObjectsResponse.Builder name(String name)
The bucket name.
name
- The bucket name.ListObjectsResponse.Builder prefix(String prefix)
Keys that begin with the indicated prefix.
prefix
- Keys that begin with the indicated prefix.ListObjectsResponse.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.ListObjectsResponse.Builder maxKeys(Integer maxKeys)
The maximum number of keys returned in the response body.
maxKeys
- The maximum number of keys returned in the response body.ListObjectsResponse.Builder commonPrefixes(Collection<CommonPrefix> commonPrefixes)
All of the keys (up to 1,000) rolled up in 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 the 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 in 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 the 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.
ListObjectsResponse.Builder commonPrefixes(CommonPrefix... commonPrefixes)
All of the keys (up to 1,000) rolled up in 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 the 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 in 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 the 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.
ListObjectsResponse.Builder commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes)
All of the keys (up to 1,000) rolled up in 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 the 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.
This is a convenience method that creates an instance of theCommonPrefix.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)
ListObjectsResponse.Builder encodingType(String encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.
encodingType
- Encoding type used by Amazon S3 to encode object keys in the response.EncodingType
,
EncodingType
ListObjectsResponse.Builder encodingType(EncodingType encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.
encodingType
- Encoding type used by Amazon S3 to encode object keys in the response.EncodingType
,
EncodingType
Copyright © 2022. All rights reserved.