@Generated(value="software.amazon.awssdk:codegen") public final class DeleteObjectsRequest extends S3Request implements ToCopyableBuilder<DeleteObjectsRequest.Builder,DeleteObjectsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DeleteObjectsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
bucket()
The bucket name containing the objects to delete.
|
static DeleteObjectsRequest.Builder |
builder() |
Boolean |
bypassGovernanceRetention()
Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place.
|
ChecksumAlgorithm |
checksumAlgorithm()
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
String |
checksumAlgorithmAsString()
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
Delete |
delete()
Container for the request.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
expectedBucketOwner()
The account ID of the expected bucket owner.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
mfa()
The concatenation of the authentication device's serial number, a space, and the value that is displayed on your
authentication device.
|
RequestPayer |
requestPayer()
Returns the value of the RequestPayer property for this object.
|
String |
requestPayerAsString()
Returns the value of the RequestPayer property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DeleteObjectsRequest.Builder> |
serializableBuilderClass() |
DeleteObjectsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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.
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.
public final Delete delete()
Container for the request.
public final 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.
public final RequestPayer requestPayer()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public final String requestPayerAsString()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public final 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.
s3:BypassGovernanceRetention
permission.public final 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).
403 Forbidden
(access denied).public final 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.
If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm
will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from checksumAlgorithmAsString()
.
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
public final String checksumAlgorithmAsString()
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.
If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm
will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from checksumAlgorithmAsString()
.
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
public DeleteObjectsRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<DeleteObjectsRequest.Builder,DeleteObjectsRequest>
toBuilder
in class S3Request
public static DeleteObjectsRequest.Builder builder()
public static Class<? extends DeleteObjectsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.