@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.
|
Delete |
delete()
Container for the request.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
expectedBucketOwner()
The account ID of the expected bucket owner.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic 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 AWS 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 using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using 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 AWS 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 using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using 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().
RequestPayerpublic 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().
RequestPayerpublic final Boolean bypassGovernanceRetention()
Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.
public final String expectedBucketOwner()
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail
with an HTTP 403 (Access Denied) error.
403 (Access Denied) error.public DeleteObjectsRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<DeleteObjectsRequest.Builder,DeleteObjectsRequest>toBuilder in class S3Requestpublic static DeleteObjectsRequest.Builder builder()
public static Class<? extends DeleteObjectsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.