@Generated(value="software.amazon.awssdk:codegen") public final class DeleteObjectRequest extends S3Request implements ToCopyableBuilder<DeleteObjectRequest.Builder,DeleteObjectRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DeleteObjectRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
bucket()
The bucket name of the bucket containing the object.
|
static DeleteObjectRequest.Builder |
builder() |
Boolean |
bypassGovernanceRetention()
Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.
|
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 |
key()
Key name of the object to delete.
|
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 DeleteObjectRequest.Builder> |
serializableBuilderClass() |
DeleteObjectRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
versionId()
VersionId used to reference a specific version of the object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String bucket()
The bucket name of the bucket containing the object.
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.
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.
public final String key()
Key name of the object to delete.
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 String versionId()
VersionId used to reference a specific version of the object.
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()
Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. 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 DeleteObjectRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<DeleteObjectRequest.Builder,DeleteObjectRequest>
toBuilder
in class S3Request
public static DeleteObjectRequest.Builder builder()
public static Class<? extends DeleteObjectRequest.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 © 2023. All rights reserved.