Interface ListObjectsResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>
,S3Response.Builder
,SdkBuilder<ListObjectsResponse.Builder,ListObjectsResponse>
,SdkPojo
,SdkResponse.Builder
- Enclosing class:
- ListObjectsResponse
public static interface ListObjectsResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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(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
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
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 theCommonPrefixes
collection.ListObjectsResponse.Builder
encodingType(String encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.ListObjectsResponse.Builder
encodingType(EncodingType 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 the response is truncated (theIsTruncated
element value in the response istrue
), you can use the key name in this field as themarker
parameter in the subsequent request to get the next set of objects.ListObjectsResponse.Builder
prefix(String prefix)
Keys that begin with the indicated prefix.ListObjectsResponse.Builder
requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.ListObjectsResponse.Builder
requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.-
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 Detail
-
isTruncated
ListObjectsResponse.Builder isTruncated(Boolean isTruncated)
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
- Parameters:
isTruncated
- A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
marker
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.
- Parameters:
marker
- Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextMarker
ListObjectsResponse.Builder nextMarker(String nextMarker)
When the response is truncated (the
IsTruncated
element value in the response istrue
), you can use the key name in this field as themarker
parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.This element is returned only if you have the
delimiter
request parameter specified. If the response does not include theNextMarker
element and it is truncated, you can use the value of the lastKey
element in the response as themarker
parameter in the subsequent request to get the next set of object keys.- Parameters:
nextMarker
- When the response is truncated (theIsTruncated
element value in the response istrue
), you can use the key name in this field as themarker
parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.This element is returned only if you have the
delimiter
request parameter specified. If the response does not include theNextMarker
element and it is truncated, you can use the value of the lastKey
element in the response as themarker
parameter in the subsequent request to get the next set of object keys.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contents
ListObjectsResponse.Builder contents(Collection<S3Object> 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
ListObjectsResponse.Builder contents(S3Object... 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
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 viaS3Object.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#contents(List
.) - 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:
#contents(java.util.Collection
)
-
name
ListObjectsResponse.Builder name(String 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
ListObjectsResponse.Builder prefix(String prefix)
Keys that begin with the indicated prefix.
- Parameters:
prefix
- Keys that begin with the indicated prefix.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
delimiter
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 theMaxKeys
value.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxKeys
ListObjectsResponse.Builder maxKeys(Integer maxKeys)
The maximum number of keys returned in the response body.
- Parameters:
maxKeys
- The maximum number of keys returned in the response body.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commonPrefixes
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 betweenPrefix
and the next occurrence of the string specified by the 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.- Parameters:
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 betweenPrefix
and the next occurrence of the string specified by the 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commonPrefixes
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 betweenPrefix
and the next occurrence of the string specified by the 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.- Parameters:
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 betweenPrefix
and the next occurrence of the string specified by the 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commonPrefixes
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 betweenPrefix
and the next occurrence of the string specified by the delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
This is a convenience method that creates an instance of thenotes/
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.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 to#commonPrefixes(List
.) - 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:
#commonPrefixes(java.util.Collection
)
-
encodingType
ListObjectsResponse.Builder encodingType(String encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.
- Parameters:
encodingType
- Encoding type used by Amazon S3 to encode object keys in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
EncodingType
,EncodingType
-
encodingType
ListObjectsResponse.Builder encodingType(EncodingType encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.
- Parameters:
encodingType
- Encoding type used by Amazon S3 to encode object keys in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
EncodingType
,EncodingType
-
requestCharged
ListObjectsResponse.Builder requestCharged(String 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
,RequestCharged
-
requestCharged
ListObjectsResponse.Builder requestCharged(RequestCharged 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
,RequestCharged
-
-