Interface ListObjectVersionsResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<ListObjectVersionsResponse.Builder,ListObjectVersionsResponse>,S3Response.Builder,SdkBuilder<ListObjectVersionsResponse.Builder,ListObjectVersionsResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- ListObjectVersionsResponse
@Mutable @NotThreadSafe public static interface ListObjectVersionsResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<ListObjectVersionsResponse.Builder,ListObjectVersionsResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListObjectVersionsResponse.BuildercommonPrefixes(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.BuildercommonPrefixes(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.BuildercommonPrefixes(CommonPrefix... commonPrefixes)All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.ListObjectVersionsResponse.BuilderdeleteMarkers(Collection<DeleteMarkerEntry> deleteMarkers)Container for an object that is a delete marker.ListObjectVersionsResponse.BuilderdeleteMarkers(Consumer<DeleteMarkerEntry.Builder>... deleteMarkers)Container for an object that is a delete marker.ListObjectVersionsResponse.BuilderdeleteMarkers(DeleteMarkerEntry... deleteMarkers)Container for an object that is a delete marker.ListObjectVersionsResponse.Builderdelimiter(String delimiter)The delimiter grouping the included keys.ListObjectVersionsResponse.BuilderencodingType(String encodingType)Encoding type used by Amazon S3 to encode object key names in the XML response.ListObjectVersionsResponse.BuilderencodingType(EncodingType encodingType)Encoding type used by Amazon S3 to encode object key names in the XML response.ListObjectVersionsResponse.BuilderisTruncated(Boolean isTruncated)A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.ListObjectVersionsResponse.BuilderkeyMarker(String keyMarker)Marks the last key returned in a truncated response.ListObjectVersionsResponse.BuildermaxKeys(Integer maxKeys)Specifies the maximum number of objects to return.ListObjectVersionsResponse.Buildername(String name)The bucket name.ListObjectVersionsResponse.BuildernextKeyMarker(String nextKeyMarker)When the number of responses exceeds the value ofMaxKeys,NextKeyMarkerspecifies the first key not returned that satisfies the search criteria.ListObjectVersionsResponse.BuildernextVersionIdMarker(String nextVersionIdMarker)When the number of responses exceeds the value ofMaxKeys,NextVersionIdMarkerspecifies the first object version not returned that satisfies the search criteria.ListObjectVersionsResponse.Builderprefix(String prefix)Selects objects that start with the value supplied by this parameter.ListObjectVersionsResponse.BuilderrequestCharged(String requestCharged)Sets the value of the RequestCharged property for this object.ListObjectVersionsResponse.BuilderrequestCharged(RequestCharged requestCharged)Sets the value of the RequestCharged property for this object.ListObjectVersionsResponse.BuilderversionIdMarker(String versionIdMarker)Marks the last version of the key returned in a truncated response.ListObjectVersionsResponse.Builderversions(Collection<ObjectVersion> versions)Container for version information.ListObjectVersionsResponse.Builderversions(Consumer<ObjectVersion.Builder>... versions)Container for version information.ListObjectVersionsResponse.Builderversions(ObjectVersion... versions)Container for version information.-
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, sdkFieldNameToField, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
isTruncated
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 by using the
NextKeyMarkerandNextVersionIdMarkerresponse parameters as a starting place in another request to return the rest of the results.- Parameters:
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 by using theNextKeyMarkerandNextVersionIdMarkerresponse parameters as a starting place in another request to return the rest of the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyMarker
ListObjectVersionsResponse.Builder keyMarker(String keyMarker)
Marks the last key returned in a truncated response.
- Parameters:
keyMarker- Marks the last key returned in a truncated response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versionIdMarker
ListObjectVersionsResponse.Builder versionIdMarker(String versionIdMarker)
Marks the last version of the key returned in a truncated response.
- Parameters:
versionIdMarker- Marks the last version of the key returned in a truncated response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextKeyMarker
ListObjectVersionsResponse.Builder nextKeyMarker(String nextKeyMarker)
When the number of responses exceeds the value of
MaxKeys,NextKeyMarkerspecifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.- Parameters:
nextKeyMarker- When the number of responses exceeds the value ofMaxKeys,NextKeyMarkerspecifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextVersionIdMarker
ListObjectVersionsResponse.Builder nextVersionIdMarker(String nextVersionIdMarker)
When the number of responses exceeds the value of
MaxKeys,NextVersionIdMarkerspecifies the first object version not returned that satisfies the search criteria. Use this value for theversion-id-markerrequest parameter in a subsequent request.- Parameters:
nextVersionIdMarker- When the number of responses exceeds the value ofMaxKeys,NextVersionIdMarkerspecifies the first object version not returned that satisfies the search criteria. Use this value for theversion-id-markerrequest parameter in a subsequent request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versions
ListObjectVersionsResponse.Builder versions(Collection<ObjectVersion> versions)
Container for version information.
- Parameters:
versions- Container for version information.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versions
ListObjectVersionsResponse.Builder versions(ObjectVersion... versions)
Container for version information.
- Parameters:
versions- Container for version information.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versions
ListObjectVersionsResponse.Builder versions(Consumer<ObjectVersion.Builder>... versions)
Container for version information.
This is a convenience method that creates an instance of theObjectVersion.Builderavoiding the need to create one manually viaObjectVersion.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#versions(List.) - Parameters:
versions- a consumer that will call methods onObjectVersion.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#versions(java.util.Collection)
-
deleteMarkers
ListObjectVersionsResponse.Builder deleteMarkers(Collection<DeleteMarkerEntry> deleteMarkers)
Container for an object that is a delete marker. To learn more about delete markers, see Working with delete markers.
- Parameters:
deleteMarkers- Container for an object that is a delete marker. To learn more about delete markers, see Working with delete markers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deleteMarkers
ListObjectVersionsResponse.Builder deleteMarkers(DeleteMarkerEntry... deleteMarkers)
Container for an object that is a delete marker. To learn more about delete markers, see Working with delete markers.
- Parameters:
deleteMarkers- Container for an object that is a delete marker. To learn more about delete markers, see Working with delete markers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deleteMarkers
ListObjectVersionsResponse.Builder deleteMarkers(Consumer<DeleteMarkerEntry.Builder>... deleteMarkers)
Container for an object that is a delete marker. To learn more about delete markers, see Working with delete markers.
This is a convenience method that creates an instance of theDeleteMarkerEntry.Builderavoiding the need to create one manually viaDeleteMarkerEntry.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#deleteMarkers(List.) - Parameters:
deleteMarkers- a consumer that will call methods onDeleteMarkerEntry.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#deleteMarkers(java.util.Collection)
-
name
ListObjectVersionsResponse.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
ListObjectVersionsResponse.Builder prefix(String prefix)
Selects objects that start with the value supplied by this parameter.
- Parameters:
prefix- Selects objects that start with the value supplied by this parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
delimiter
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 themax-keyslimitation. These keys are not returned elsewhere in the response.- Parameters:
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 inCommonPrefixes. These groups are counted as one result against themax-keyslimitation. These keys are not returned elsewhere in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxKeys
ListObjectVersionsResponse.Builder maxKeys(Integer maxKeys)
Specifies the maximum number of objects to return.
- Parameters:
maxKeys- Specifies the maximum number of objects to return.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commonPrefixes
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.
- Parameters:
commonPrefixes- All of the keys rolled 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
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.
- Parameters:
commonPrefixes- All of the keys rolled 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
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 method that creates an instance of theCommonPrefix.Builderavoiding the need to create one manually viaCommonPrefix.builder().When the
Consumercompletes,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
ListObjectVersionsResponse.Builder encodingType(String encodingType)
Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify the
encoding-typerequest parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:KeyMarker, NextKeyMarker, Prefix, Key, andDelimiter.- Parameters:
encodingType- Encoding type used by Amazon S3 to encode object key names in the XML response.If you specify the
encoding-typerequest parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:KeyMarker, NextKeyMarker, Prefix, Key, andDelimiter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
EncodingType,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 the
encoding-typerequest parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:KeyMarker, NextKeyMarker, Prefix, Key, andDelimiter.- Parameters:
encodingType- Encoding type used by Amazon S3 to encode object key names in the XML response.If you specify the
encoding-typerequest parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:KeyMarker, NextKeyMarker, Prefix, Key, andDelimiter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
EncodingType,EncodingType
-
requestCharged
ListObjectVersionsResponse.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
ListObjectVersionsResponse.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
-
-