public static interface DeleteObjectsRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<DeleteObjectsRequest.Builder,DeleteObjectsRequest>
Modifier and Type | Method and Description |
---|---|
DeleteObjectsRequest.Builder |
bucket(String bucket)
The bucket name containing the objects to delete.
|
DeleteObjectsRequest.Builder |
bypassGovernanceRetention(Boolean bypassGovernanceRetention)
Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place.
|
DeleteObjectsRequest.Builder |
checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
DeleteObjectsRequest.Builder |
checksumAlgorithm(String checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
default DeleteObjectsRequest.Builder |
delete(Consumer<Delete.Builder> delete)
Container for the request.
|
DeleteObjectsRequest.Builder |
delete(Delete delete)
Container for the request.
|
DeleteObjectsRequest.Builder |
expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.
|
DeleteObjectsRequest.Builder |
mfa(String mfa)
The concatenation of the authentication device's serial number, a space, and the value that is displayed on
your authentication device.
|
DeleteObjectsRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
DeleteObjectsRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
DeleteObjectsRequest.Builder |
requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.
|
DeleteObjectsRequest.Builder |
requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
DeleteObjectsRequest.Builder bucket(String bucket)
The bucket name containing the objects to delete.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname.
The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on
Outposts in the Amazon S3 User Guide.
bucket
- The bucket name containing the objects to delete.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on
Outposts in the Amazon S3 User Guide.
DeleteObjectsRequest.Builder delete(Delete delete)
Container for the request.
delete
- Container for the request.default DeleteObjectsRequest.Builder delete(Consumer<Delete.Builder> delete)
Container for the request.
This is a convenience method that creates an instance of theDelete.Builder
avoiding the need to
create one manually via Delete.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result is
passed to delete(Delete)
.
delete
- a consumer that will call methods on Delete.Builder
delete(Delete)
DeleteObjectsRequest.Builder mfa(String mfa)
The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.
mfa
- The concatenation of the authentication device's serial number, a space, and the value that is
displayed on your authentication device. Required to permanently delete a versioned object if
versioning is configured with MFA delete enabled.DeleteObjectsRequest.Builder requestPayer(String requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
DeleteObjectsRequest.Builder requestPayer(RequestPayer requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
DeleteObjectsRequest.Builder bypassGovernanceRetention(Boolean bypassGovernanceRetention)
Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To
use this header, you must have the s3:BypassGovernanceRetention
permission.
bypassGovernanceRetention
- Specifies whether you want to delete this object even if it has a Governance-type Object Lock in
place. To use this header, you must have the s3:BypassGovernanceRetention
permission.DeleteObjectsRequest.Builder expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails
with the HTTP status code 403 Forbidden
(access denied).
expectedBucketOwner
- The account ID of the expected bucket owner. If the bucket is owned by a different account, the
request fails with the HTTP status code 403 Forbidden
(access denied).DeleteObjectsRequest.Builder checksumAlgorithm(String checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not
provide any additional functionality if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3
fails the request with the HTTP status code 400 Bad Request
. For more information, see Checking object
integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
This checksum algorithm must be the same for all parts and it match the checksum value supplied in the
CreateMultipartUpload
request.
checksumAlgorithm
- Indicates the algorithm used to create the checksum for the object when using the SDK. This header
will not provide any additional functionality if not using the SDK. When sending this header, there
must be a corresponding x-amz-checksum
or x-amz-trailer
header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
. For
more information, see Checking
object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
This checksum algorithm must be the same for all parts and it match the checksum value supplied in the
CreateMultipartUpload
request.
ChecksumAlgorithm
,
ChecksumAlgorithm
DeleteObjectsRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not
provide any additional functionality if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3
fails the request with the HTTP status code 400 Bad Request
. For more information, see Checking object
integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
This checksum algorithm must be the same for all parts and it match the checksum value supplied in the
CreateMultipartUpload
request.
checksumAlgorithm
- Indicates the algorithm used to create the checksum for the object when using the SDK. This header
will not provide any additional functionality if not using the SDK. When sending this header, there
must be a corresponding x-amz-checksum
or x-amz-trailer
header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
. For
more information, see Checking
object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
This checksum algorithm must be the same for all parts and it match the checksum value supplied in the
CreateMultipartUpload
request.
ChecksumAlgorithm
,
ChecksumAlgorithm
DeleteObjectsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
DeleteObjectsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2023. All rights reserved.