public static interface ListObjectVersionsResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<ListObjectVersionsResponse.Builder,ListObjectVersionsResponse>
Modifier and Type | Method and Description |
---|---|
ListObjectVersionsResponse.Builder |
commonPrefixes(Collection<CommonPrefix> commonPrefixes)
All of the keys rolled up into a common prefix count as a single return when calculating the number of
returns.
|
ListObjectVersionsResponse.Builder |
commonPrefixes(CommonPrefix... commonPrefixes)
All of the keys rolled up into a common prefix count as a single return when calculating the number of
returns.
|
ListObjectVersionsResponse.Builder |
commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes)
All of the keys rolled up into a common prefix count as a single return when calculating the number of
returns.
|
ListObjectVersionsResponse.Builder |
deleteMarkers(Collection<DeleteMarkerEntry> deleteMarkers)
Container for an object that is a delete marker.
|
ListObjectVersionsResponse.Builder |
deleteMarkers(Consumer<DeleteMarkerEntry.Builder>... deleteMarkers)
Container for an object that is a delete marker.
|
ListObjectVersionsResponse.Builder |
deleteMarkers(DeleteMarkerEntry... deleteMarkers)
Container for an object that is a delete marker.
|
ListObjectVersionsResponse.Builder |
delimiter(String delimiter)
The delimiter grouping the included keys.
|
ListObjectVersionsResponse.Builder |
encodingType(EncodingType encodingType)
Encoding type used by Amazon S3 to encode object key names in the XML response.
|
ListObjectVersionsResponse.Builder |
encodingType(String encodingType)
Encoding type used by Amazon S3 to encode object key names in the XML response.
|
ListObjectVersionsResponse.Builder |
isTruncated(Boolean isTruncated)
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
|
ListObjectVersionsResponse.Builder |
keyMarker(String keyMarker)
Marks the last key returned in a truncated response.
|
ListObjectVersionsResponse.Builder |
maxKeys(Integer maxKeys)
Specifies the maximum number of objects to return.
|
ListObjectVersionsResponse.Builder |
name(String name)
The bucket name.
|
ListObjectVersionsResponse.Builder |
nextKeyMarker(String nextKeyMarker)
When the number of responses exceeds the value of
MaxKeys , NextKeyMarker specifies
the first key not returned that satisfies the search criteria. |
ListObjectVersionsResponse.Builder |
nextVersionIdMarker(String nextVersionIdMarker)
When the number of responses exceeds the value of
MaxKeys , NextVersionIdMarker
specifies the first object version not returned that satisfies the search criteria. |
ListObjectVersionsResponse.Builder |
prefix(String prefix)
Selects objects that start with the value supplied by this parameter.
|
ListObjectVersionsResponse.Builder |
versionIdMarker(String versionIdMarker)
Marks the last version of the key returned in a truncated response.
|
ListObjectVersionsResponse.Builder |
versions(Collection<ObjectVersion> versions)
Container for version information.
|
ListObjectVersionsResponse.Builder |
versions(Consumer<ObjectVersion.Builder>... versions)
Container for version information.
|
ListObjectVersionsResponse.Builder |
versions(ObjectVersion... versions)
Container for version information.
|
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
ListObjectVersionsResponse.Builder isTruncated(Boolean isTruncated)
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.
isTruncated
- A flag that indicates whether Amazon S3 returned all of the results that satisfied the search
criteria. If your results were truncated, you can make a follow-up paginated request using the
NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to
return the rest of the results.ListObjectVersionsResponse.Builder keyMarker(String keyMarker)
Marks the last key returned in a truncated response.
keyMarker
- Marks the last key returned in a truncated response.ListObjectVersionsResponse.Builder versionIdMarker(String versionIdMarker)
Marks the last version of the key returned in a truncated response.
versionIdMarker
- Marks the last version of the key returned in a truncated response.ListObjectVersionsResponse.Builder nextKeyMarker(String nextKeyMarker)
When the number of responses exceeds the value of MaxKeys
, NextKeyMarker
specifies
the first key not returned that satisfies the search criteria. Use this value for the key-marker request
parameter in a subsequent request.
nextKeyMarker
- When the number of responses exceeds the value of MaxKeys
, NextKeyMarker
specifies the first key not returned that satisfies the search criteria. Use this value for the
key-marker request parameter in a subsequent request.ListObjectVersionsResponse.Builder nextVersionIdMarker(String nextVersionIdMarker)
When the number of responses exceeds the value of MaxKeys
, NextVersionIdMarker
specifies the first object version not returned that satisfies the search criteria. Use this value for the
version-id-marker request parameter in a subsequent request.
nextVersionIdMarker
- When the number of responses exceeds the value of MaxKeys
,
NextVersionIdMarker
specifies the first object version not returned that satisfies the
search criteria. Use this value for the version-id-marker request parameter in a subsequent request.ListObjectVersionsResponse.Builder versions(Collection<ObjectVersion> versions)
Container for version information.
versions
- Container for version information.ListObjectVersionsResponse.Builder versions(ObjectVersion... versions)
Container for version information.
versions
- Container for version information.ListObjectVersionsResponse.Builder versions(Consumer<ObjectVersion.Builder>... versions)
Container for version information.
This is a convenience 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 #versions(List)
.versions
- a consumer that will call methods on List.Builder
#versions(List)
ListObjectVersionsResponse.Builder deleteMarkers(Collection<DeleteMarkerEntry> deleteMarkers)
Container for an object that is a delete marker.
deleteMarkers
- Container for an object that is a delete marker.ListObjectVersionsResponse.Builder deleteMarkers(DeleteMarkerEntry... deleteMarkers)
Container for an object that is a delete marker.
deleteMarkers
- Container for an object that is a delete marker.ListObjectVersionsResponse.Builder deleteMarkers(Consumer<DeleteMarkerEntry.Builder>... deleteMarkers)
Container for an object that is a delete marker.
This is a convenience 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 #deleteMarkers(List)
.deleteMarkers
- a consumer that will call methods on List.Builder
#deleteMarkers(List)
ListObjectVersionsResponse.Builder name(String name)
The bucket name.
name
- The bucket name.ListObjectVersionsResponse.Builder prefix(String prefix)
Selects objects that start with the value supplied by this parameter.
prefix
- Selects objects that start with the value supplied by this parameter.ListObjectVersionsResponse.Builder delimiter(String delimiter)
The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys
that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a
single result element in CommonPrefixes
. These groups are counted as one result against the
max-keys limitation. These keys are not returned elsewhere in the response.
delimiter
- The delimiter grouping the included keys. A delimiter is a character that you specify to group keys.
All keys that contain the same string between the prefix and the first occurrence of the delimiter are
grouped under a single result element in CommonPrefixes
. These groups are counted as one
result against the max-keys limitation. These keys are not returned elsewhere in the response.ListObjectVersionsResponse.Builder maxKeys(Integer maxKeys)
Specifies the maximum number of objects to return.
maxKeys
- Specifies the maximum number of objects to return.ListObjectVersionsResponse.Builder commonPrefixes(Collection<CommonPrefix> commonPrefixes)
All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
commonPrefixes
- All of the keys rolled up into a common prefix count as a single return when calculating the number of
returns.ListObjectVersionsResponse.Builder commonPrefixes(CommonPrefix... commonPrefixes)
All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
commonPrefixes
- All of the keys rolled up into a common prefix count as a single return when calculating the number of
returns.ListObjectVersionsResponse.Builder commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes)
All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
This is a convenience 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 #commonPrefixes(List)
.commonPrefixes
- a consumer that will call methods on List.Builder
#commonPrefixes(List)
ListObjectVersionsResponse.Builder encodingType(String encodingType)
Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
KeyMarker, NextKeyMarker, Prefix, Key
, and Delimiter
.
encodingType
- Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
KeyMarker, NextKeyMarker, Prefix, Key
, and Delimiter
.
EncodingType
,
EncodingType
ListObjectVersionsResponse.Builder encodingType(EncodingType encodingType)
Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
KeyMarker, NextKeyMarker, Prefix, Key
, and Delimiter
.
encodingType
- Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
KeyMarker, NextKeyMarker, Prefix, Key
, and Delimiter
.
EncodingType
,
EncodingType
Copyright © 2022. All rights reserved.