Interface ListPartsResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<ListPartsResponse.Builder,ListPartsResponse>
,S3Response.Builder
,SdkBuilder<ListPartsResponse.Builder,ListPartsResponse>
,SdkPojo
,SdkResponse.Builder
- Enclosing class:
- ListPartsResponse
public static interface ListPartsResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<ListPartsResponse.Builder,ListPartsResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ListPartsResponse.Builder
abortDate(Instant abortDate)
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation.ListPartsResponse.Builder
abortRuleId(String abortRuleId)
This header is returned along with thex-amz-abort-date
header.ListPartsResponse.Builder
bucket(String bucket)
The name of the bucket to which the multipart upload was initiated.ListPartsResponse.Builder
checksumAlgorithm(String checksumAlgorithm)
The algorithm that was used to create a checksum of the object.ListPartsResponse.Builder
checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
The algorithm that was used to create a checksum of the object.default ListPartsResponse.Builder
initiator(Consumer<Initiator.Builder> initiator)
Container element that identifies who initiated the multipart upload.ListPartsResponse.Builder
initiator(Initiator initiator)
Container element that identifies who initiated the multipart upload.ListPartsResponse.Builder
isTruncated(Boolean isTruncated)
Indicates whether the returned list of parts is truncated.ListPartsResponse.Builder
key(String key)
Object key for which the multipart upload was initiated.ListPartsResponse.Builder
maxParts(Integer maxParts)
Maximum number of parts that were allowed in the response.ListPartsResponse.Builder
nextPartNumberMarker(Integer nextPartNumberMarker)
When a list is truncated, this element specifies the last part in the list, as well as the value to use for thepart-number-marker
request parameter in a subsequent request.default ListPartsResponse.Builder
owner(Consumer<Owner.Builder> owner)
Container element that identifies the object owner, after the object is created.ListPartsResponse.Builder
owner(Owner owner)
Container element that identifies the object owner, after the object is created.ListPartsResponse.Builder
partNumberMarker(Integer partNumberMarker)
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.ListPartsResponse.Builder
parts(Collection<Part> parts)
Container for elements related to a particular part.ListPartsResponse.Builder
parts(Consumer<Part.Builder>... parts)
Container for elements related to a particular part.ListPartsResponse.Builder
parts(Part... parts)
Container for elements related to a particular part.ListPartsResponse.Builder
requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.ListPartsResponse.Builder
requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.ListPartsResponse.Builder
storageClass(String storageClass)
The class of storage used to store the uploaded object.ListPartsResponse.Builder
storageClass(StorageClass storageClass)
The class of storage used to store the uploaded object.ListPartsResponse.Builder
uploadId(String uploadId)
Upload ID identifying the multipart upload whose parts are being listed.-
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
-
abortDate
ListPartsResponse.Builder abortDate(Instant abortDate)
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
The response will also include the
x-amz-abort-rule-id
header that will provide the ID of the lifecycle configuration rule that defines this action.This functionality is not supported for directory buckets.
- Parameters:
abortDate
- If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.The response will also include the
x-amz-abort-rule-id
header that will provide the ID of the lifecycle configuration rule that defines this action.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
abortRuleId
ListPartsResponse.Builder abortRuleId(String abortRuleId)
This header is returned along with the
x-amz-abort-date
header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.This functionality is not supported for directory buckets.
- Parameters:
abortRuleId
- This header is returned along with thex-amz-abort-date
header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bucket
ListPartsResponse.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.
-
key
ListPartsResponse.Builder key(String key)
Object key for which the multipart upload was initiated.
- Parameters:
key
- Object key for which the multipart upload was initiated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
uploadId
ListPartsResponse.Builder uploadId(String uploadId)
Upload ID identifying the multipart upload whose parts are being listed.
- Parameters:
uploadId
- Upload ID identifying the multipart upload whose parts are being listed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
partNumberMarker
ListPartsResponse.Builder partNumberMarker(Integer partNumberMarker)
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
- Parameters:
partNumberMarker
- When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextPartNumberMarker
ListPartsResponse.Builder nextPartNumberMarker(Integer nextPartNumberMarker)
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the
part-number-marker
request parameter in a subsequent request.- Parameters:
nextPartNumberMarker
- When a list is truncated, this element specifies the last part in the list, as well as the value to use for thepart-number-marker
request parameter in a subsequent request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxParts
ListPartsResponse.Builder maxParts(Integer maxParts)
Maximum number of parts that were allowed in the response.
- Parameters:
maxParts
- Maximum number of parts that were allowed in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isTruncated
ListPartsResponse.Builder isTruncated(Boolean isTruncated)
Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.
- Parameters:
isTruncated
- Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parts
ListPartsResponse.Builder parts(Collection<Part> parts)
Container for elements related to a particular part. A response can contain zero or more
Part
elements.- Parameters:
parts
- Container for elements related to a particular part. A response can contain zero or morePart
elements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parts
ListPartsResponse.Builder parts(Part... parts)
Container for elements related to a particular part. A response can contain zero or more
Part
elements.- Parameters:
parts
- Container for elements related to a particular part. A response can contain zero or morePart
elements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parts
ListPartsResponse.Builder parts(Consumer<Part.Builder>... parts)
Container for elements related to a particular part. A response can contain zero or more
This is a convenience method that creates an instance of thePart
elements.Part.Builder
avoiding the need to create one manually viaPart.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#parts(List
.) - Parameters:
parts
- a consumer that will call methods onPart.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#parts(java.util.Collection
)
-
initiator
ListPartsResponse.Builder initiator(Initiator initiator)
Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services account, this element provides the same information as the
Owner
element. If the initiator is an IAM User, this element provides the user ARN and display name.- Parameters:
initiator
- Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services account, this element provides the same information as theOwner
element. If the initiator is an IAM User, this element provides the user ARN and display name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
initiator
default ListPartsResponse.Builder initiator(Consumer<Initiator.Builder> initiator)
Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services account, this element provides the same information as the
This is a convenience method that creates an instance of theOwner
element. If the initiator is an IAM User, this element provides the user ARN and display name.Initiator.Builder
avoiding the need to create one manually viaInitiator.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinitiator(Initiator)
.- Parameters:
initiator
- a consumer that will call methods onInitiator.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
initiator(Initiator)
-
owner
ListPartsResponse.Builder owner(Owner owner)
Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.
Directory buckets - The bucket owner is returned as the object owner for all the parts.
- Parameters:
owner
- Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.Directory buckets - The bucket owner is returned as the object owner for all the parts.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
owner
default ListPartsResponse.Builder owner(Consumer<Owner.Builder> owner)
Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.
Directory buckets - The bucket owner is returned as the object owner for all the parts.
Owner.Builder
avoiding the need to create one manually viaOwner.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toowner(Owner)
.- Parameters:
owner
- a consumer that will call methods onOwner.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
owner(Owner)
-
storageClass
ListPartsResponse.Builder storageClass(String storageClass)
The class of storage used to store the uploaded object.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- Parameters:
storageClass
- The class of storage used to store the uploaded object.Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
StorageClass
,StorageClass
-
storageClass
ListPartsResponse.Builder storageClass(StorageClass storageClass)
The class of storage used to store the uploaded object.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- Parameters:
storageClass
- The class of storage used to store the uploaded object.Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
StorageClass
,StorageClass
-
requestCharged
ListPartsResponse.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
ListPartsResponse.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
-
checksumAlgorithm
ListPartsResponse.Builder checksumAlgorithm(String checksumAlgorithm)
The algorithm that was used to create a checksum of the object.
- Parameters:
checksumAlgorithm
- The algorithm that was used to create a checksum of the object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChecksumAlgorithm
,ChecksumAlgorithm
-
checksumAlgorithm
ListPartsResponse.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
The algorithm that was used to create a checksum of the object.
- Parameters:
checksumAlgorithm
- The algorithm that was used to create a checksum of the object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChecksumAlgorithm
,ChecksumAlgorithm
-
-