Interface ListMultipartUploadsResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<ListMultipartUploadsResponse.Builder,ListMultipartUploadsResponse>
,S3Response.Builder
,SdkBuilder<ListMultipartUploadsResponse.Builder,ListMultipartUploadsResponse>
,SdkPojo
,SdkResponse.Builder
- Enclosing class:
- ListMultipartUploadsResponse
public static interface ListMultipartUploadsResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<ListMultipartUploadsResponse.Builder,ListMultipartUploadsResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListMultipartUploadsResponse.Builder
bucket(String bucket)
The name of the bucket to which the multipart upload was initiated.ListMultipartUploadsResponse.Builder
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.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 aCommonPrefixes
element.ListMultipartUploadsResponse.Builder
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.ListMultipartUploadsResponse.Builder
delimiter(String delimiter)
Contains the delimiter you specified in the request.ListMultipartUploadsResponse.Builder
encodingType(String encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.ListMultipartUploadsResponse.Builder
encodingType(EncodingType encodingType)
Encoding type used by Amazon S3 to encode object keys in the response.ListMultipartUploadsResponse.Builder
isTruncated(Boolean isTruncated)
Indicates whether the returned list of multipart uploads is truncated.ListMultipartUploadsResponse.Builder
keyMarker(String keyMarker)
The key at or after which the listing began.ListMultipartUploadsResponse.Builder
maxUploads(Integer maxUploads)
Maximum number of multipart uploads that could have been included in the response.ListMultipartUploadsResponse.Builder
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.ListMultipartUploadsResponse.Builder
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.ListMultipartUploadsResponse.Builder
prefix(String prefix)
When a prefix is provided in the request, this field contains the specified prefix.ListMultipartUploadsResponse.Builder
requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.ListMultipartUploadsResponse.Builder
requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.ListMultipartUploadsResponse.Builder
uploadIdMarker(String uploadIdMarker)
Upload ID after which listing began.ListMultipartUploadsResponse.Builder
uploads(Collection<MultipartUpload> uploads)
Container for elements related to a particular multipart upload.ListMultipartUploadsResponse.Builder
uploads(Consumer<MultipartUpload.Builder>... uploads)
Container for elements related to a particular multipart upload.ListMultipartUploadsResponse.Builder
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 Detail
-
bucket
ListMultipartUploadsResponse.Builder bucket(String 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
ListMultipartUploadsResponse.Builder keyMarker(String 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
ListMultipartUploadsResponse.Builder uploadIdMarker(String uploadIdMarker)
Upload ID after which listing began.
- Parameters:
uploadIdMarker
- Upload ID after which listing began.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextKeyMarker
ListMultipartUploadsResponse.Builder 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.
- 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
ListMultipartUploadsResponse.Builder prefix(String 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.
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
delimiter
ListMultipartUploadsResponse.Builder delimiter(String 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.
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextUploadIdMarker
ListMultipartUploadsResponse.Builder nextUploadIdMarker(String 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.- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxUploads
ListMultipartUploadsResponse.Builder maxUploads(Integer 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
ListMultipartUploadsResponse.Builder isTruncated(Boolean 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
ListMultipartUploadsResponse.Builder uploads(Collection<MultipartUpload> 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
ListMultipartUploadsResponse.Builder uploads(MultipartUpload... 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
ListMultipartUploadsResponse.Builder uploads(Consumer<MultipartUpload.Builder>... 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 to#uploads(List
.) - 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:
#uploads(java.util.Collection
)
-
commonPrefixes
ListMultipartUploadsResponse.Builder commonPrefixes(Collection<CommonPrefix> 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.- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commonPrefixes
ListMultipartUploadsResponse.Builder commonPrefixes(CommonPrefix... 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.- 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.- 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
This is a convenience method that creates an instance of theCommonPrefixes
element. The distinct key prefixes are returned in thePrefix
child element.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
ListMultipartUploadsResponse.Builder encodingType(String 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
,EncodingType
-
encodingType
ListMultipartUploadsResponse.Builder encodingType(EncodingType 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
,EncodingType
-
requestCharged
ListMultipartUploadsResponse.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
ListMultipartUploadsResponse.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
-
-