Class DeleteObjectsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.s3.model.S3Request
-
- software.amazon.awssdk.services.s3.model.DeleteObjectsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DeleteObjectsRequest.Builder,DeleteObjectsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DeleteObjectsRequest extends S3Request implements ToCopyableBuilder<DeleteObjectsRequest.Builder,DeleteObjectsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DeleteObjectsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
bucket
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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.- Returns:
- 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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
-
delete
public final Delete delete()
Container for the request.
- Returns:
- Container for the request.
-
mfa
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.
- Returns:
- 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.
-
requestPayer
public final RequestPayer requestPayer()
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
RequestPayer
-
requestPayerAsString
public final String requestPayerAsString()
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
RequestPayer
-
bypassGovernanceRetention
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.- Returns:
- 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.
-
expectedBucketOwner
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).- Returns:
- 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).
-
checksumAlgorithm
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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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 returnChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumAlgorithmAsString()
.- Returns:
- 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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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. - See Also:
ChecksumAlgorithm
-
checksumAlgorithmAsString
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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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 returnChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumAlgorithmAsString()
.- Returns:
- 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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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. - See Also:
ChecksumAlgorithm
-
toBuilder
public DeleteObjectsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DeleteObjectsRequest.Builder,DeleteObjectsRequest>
- Specified by:
toBuilder
in classS3Request
-
builder
public static DeleteObjectsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DeleteObjectsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-