Interface ListMultipartUploadsResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<ListMultipartUploadsResponse.Builder,
,ListMultipartUploadsResponse> S3Response.Builder
,SdkBuilder<ListMultipartUploadsResponse.Builder,
,ListMultipartUploadsResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
ListMultipartUploadsResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the bucket to which the multipart upload was initiated.commonPrefixes
(Collection<CommonPrefix> commonPrefixes) If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in aCommonPrefixes
element.commonPrefixes
(Consumer<CommonPrefix.Builder>... commonPrefixes) If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in aCommonPrefixes
element.commonPrefixes
(CommonPrefix... commonPrefixes) If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in aCommonPrefixes
element.Contains the delimiter you specified in the request.encodingType
(String encodingType) Encoding type used by Amazon S3 to encode object keys in the response.encodingType
(EncodingType encodingType) Encoding type used by Amazon S3 to encode object keys in the response.isTruncated
(Boolean isTruncated) Indicates whether the returned list of multipart uploads is truncated.The key at or after which the listing began.maxUploads
(Integer maxUploads) Maximum number of multipart uploads that could have been included in the response.nextKeyMarker
(String nextKeyMarker) When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.nextUploadIdMarker
(String nextUploadIdMarker) When a list is truncated, this element specifies the value that should be used for theupload-id-marker
request parameter in a subsequent request.When a prefix is provided in the request, this field contains the specified prefix.requestCharged
(String requestCharged) Sets the value of the RequestCharged property for this object.requestCharged
(RequestCharged requestCharged) Sets the value of the RequestCharged property for this object.uploadIdMarker
(String uploadIdMarker) Together with key-marker, specifies the multipart upload after which listing should begin.uploads
(Collection<MultipartUpload> uploads) Container for elements related to a particular multipart upload.uploads
(Consumer<MultipartUpload.Builder>... uploads) Container for elements related to a particular multipart upload.uploads
(MultipartUpload... uploads) Container for elements related to a particular multipart upload.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 Details
-
bucket
The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.
- Parameters:
bucket
- The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyMarker
The key at or after which the listing began.
- Parameters:
keyMarker
- The key at or after which the listing began.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
uploadIdMarker
Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified
upload-id-marker
.This functionality is not supported for directory buckets.
- Parameters:
uploadIdMarker
- Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specifiedupload-id-marker
.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextKeyMarker
When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.
- Parameters:
nextKeyMarker
- When a list is truncated, this element specifies the value that should be used 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.
-
prefix
When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.- Parameters:
prefix
- When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
delimiter
Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.
Directory buckets - For directory buckets,
/
is the only supported delimiter.- Parameters:
delimiter
- Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.Directory buckets - For directory buckets,
/
is the only supported delimiter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextUploadIdMarker
When a list is truncated, this element specifies the value that should be used for the
upload-id-marker
request parameter in a subsequent request.This functionality is not supported for directory buckets.
- Parameters:
nextUploadIdMarker
- When a list is truncated, this element specifies the value that should be used for theupload-id-marker
request parameter in a subsequent request.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxUploads
Maximum number of multipart uploads that could have been included in the response.
- Parameters:
maxUploads
- Maximum number of multipart uploads that could have been included in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isTruncated
Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.
- Parameters:
isTruncated
- Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
uploads
Container for elements related to a particular multipart upload. A response can contain zero or more
Upload
elements.- Parameters:
uploads
- Container for elements related to a particular multipart upload. A response can contain zero or moreUpload
elements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
uploads
Container for elements related to a particular multipart upload. A response can contain zero or more
Upload
elements.- Parameters:
uploads
- Container for elements related to a particular multipart upload. A response can contain zero or moreUpload
elements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
uploads
Container for elements related to a particular multipart upload. A response can contain zero or more
This is a convenience method that creates an instance of theUpload
elements.MultipartUpload.Builder
avoiding the need to create one manually viaMultipartUpload.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touploads(List<MultipartUpload>)
.- Parameters:
uploads
- a consumer that will call methods onMultipartUpload.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
commonPrefixes
If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a
CommonPrefixes
element. The distinct key prefixes are returned in thePrefix
child element.Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.- Parameters:
commonPrefixes
- If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in aCommonPrefixes
element. The distinct key prefixes are returned in thePrefix
child element.Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commonPrefixes
If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a
CommonPrefixes
element. The distinct key prefixes are returned in thePrefix
child element.Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.- Parameters:
commonPrefixes
- If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in aCommonPrefixes
element. The distinct key prefixes are returned in thePrefix
child element.Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commonPrefixes
ListMultipartUploadsResponse.Builder commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes) If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a
CommonPrefixes
element. The distinct key prefixes are returned in thePrefix
child element.Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported.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 tocommonPrefixes(List<CommonPrefix>)
.- 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:
-
encodingType
Encoding type used by Amazon S3 to encode object keys in the 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
,KeyMarker
,Prefix
,NextKeyMarker
,Key
.- Parameters:
encodingType
- Encoding type used by Amazon S3 to encode object keys in the 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
,KeyMarker
,Prefix
,NextKeyMarker
,Key
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
encodingType
Encoding type used by Amazon S3 to encode object keys in the 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
,KeyMarker
,Prefix
,NextKeyMarker
,Key
.- Parameters:
encodingType
- Encoding type used by Amazon S3 to encode object keys in the 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
,KeyMarker
,Prefix
,NextKeyMarker
,Key
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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:
-