software.amazon.awssdk.services.s3.model.DeleteObjectRequest Maven / Gradle / Ivy
Show all versions of s3 Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.s3.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DeleteObjectRequest extends S3Request implements
ToCopyableBuilder {
private static final SdkField BUCKET_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Bucket")
.getter(getter(DeleteObjectRequest::bucket))
.setter(setter(Builder::bucket))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("Bucket")
.unmarshallLocationName("Bucket").build()).build();
private static final SdkField KEY_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Key")
.getter(getter(DeleteObjectRequest::key))
.setter(setter(Builder::key))
.traits(LocationTrait.builder().location(MarshallLocation.GREEDY_PATH).locationName("Key")
.unmarshallLocationName("Key").build()).build();
private static final SdkField MFA_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("MFA")
.getter(getter(DeleteObjectRequest::mfa))
.setter(setter(Builder::mfa))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-mfa")
.unmarshallLocationName("x-amz-mfa").build()).build();
private static final SdkField VERSION_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("VersionId")
.getter(getter(DeleteObjectRequest::versionId))
.setter(setter(Builder::versionId))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("versionId")
.unmarshallLocationName("versionId").build()).build();
private static final SdkField REQUEST_PAYER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("RequestPayer")
.getter(getter(DeleteObjectRequest::requestPayerAsString))
.setter(setter(Builder::requestPayer))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-request-payer")
.unmarshallLocationName("x-amz-request-payer").build()).build();
private static final SdkField BYPASS_GOVERNANCE_RETENTION_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("BypassGovernanceRetention")
.getter(getter(DeleteObjectRequest::bypassGovernanceRetention))
.setter(setter(Builder::bypassGovernanceRetention))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-bypass-governance-retention")
.unmarshallLocationName("x-amz-bypass-governance-retention").build()).build();
private static final SdkField EXPECTED_BUCKET_OWNER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ExpectedBucketOwner")
.getter(getter(DeleteObjectRequest::expectedBucketOwner))
.setter(setter(Builder::expectedBucketOwner))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-expected-bucket-owner")
.unmarshallLocationName("x-amz-expected-bucket-owner").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BUCKET_FIELD, KEY_FIELD,
MFA_FIELD, VERSION_ID_FIELD, REQUEST_PAYER_FIELD, BYPASS_GOVERNANCE_RETENTION_FIELD, EXPECTED_BUCKET_OWNER_FIELD));
private final String bucket;
private final String key;
private final String mfa;
private final String versionId;
private final String requestPayer;
private final Boolean bypassGovernanceRetention;
private final String expectedBucketOwner;
private DeleteObjectRequest(BuilderImpl builder) {
super(builder);
this.bucket = builder.bucket;
this.key = builder.key;
this.mfa = builder.mfa;
this.versionId = builder.versionId;
this.requestPayer = builder.requestPayer;
this.bypassGovernanceRetention = builder.bypassGovernanceRetention;
this.expectedBucketOwner = builder.expectedBucketOwner;
}
/**
*
* 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 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.
*
*
* @return 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 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 String bucket() {
return bucket;
}
/**
*
* Key name of the object to delete.
*
*
* @return Key name of the object to delete.
*/
public final String key() {
return key;
}
/**
*
* 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.
*
*
* @return 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 mfa() {
return mfa;
}
/**
*
* VersionId used to reference a specific version of the object.
*
*
* @return VersionId used to reference a specific version of the object.
*/
public final String versionId() {
return versionId;
}
/**
* 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, {@link #requestPayer} will
* return {@link RequestPayer#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #requestPayerAsString}.
*
*
* @return The value of the RequestPayer property for this object.
* @see RequestPayer
*/
public final RequestPayer requestPayer() {
return RequestPayer.fromValue(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, {@link #requestPayer} will
* return {@link RequestPayer#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #requestPayerAsString}.
*
*
* @return The value of the RequestPayer property for this object.
* @see RequestPayer
*/
public final String requestPayerAsString() {
return requestPayer;
}
/**
*
* Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.
*
*
* @return Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.
*/
public final Boolean bypassGovernanceRetention() {
return bypassGovernanceRetention;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String expectedBucketOwner() {
return expectedBucketOwner;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(bucket());
hashCode = 31 * hashCode + Objects.hashCode(key());
hashCode = 31 * hashCode + Objects.hashCode(mfa());
hashCode = 31 * hashCode + Objects.hashCode(versionId());
hashCode = 31 * hashCode + Objects.hashCode(requestPayerAsString());
hashCode = 31 * hashCode + Objects.hashCode(bypassGovernanceRetention());
hashCode = 31 * hashCode + Objects.hashCode(expectedBucketOwner());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DeleteObjectRequest)) {
return false;
}
DeleteObjectRequest other = (DeleteObjectRequest) obj;
return Objects.equals(bucket(), other.bucket()) && Objects.equals(key(), other.key())
&& Objects.equals(mfa(), other.mfa()) && Objects.equals(versionId(), other.versionId())
&& Objects.equals(requestPayerAsString(), other.requestPayerAsString())
&& Objects.equals(bypassGovernanceRetention(), other.bypassGovernanceRetention())
&& Objects.equals(expectedBucketOwner(), other.expectedBucketOwner());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DeleteObjectRequest").add("Bucket", bucket()).add("Key", key()).add("MFA", mfa())
.add("VersionId", versionId()).add("RequestPayer", requestPayerAsString())
.add("BypassGovernanceRetention", bypassGovernanceRetention()).add("ExpectedBucketOwner", expectedBucketOwner())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Bucket":
return Optional.ofNullable(clazz.cast(bucket()));
case "Key":
return Optional.ofNullable(clazz.cast(key()));
case "MFA":
return Optional.ofNullable(clazz.cast(mfa()));
case "VersionId":
return Optional.ofNullable(clazz.cast(versionId()));
case "RequestPayer":
return Optional.ofNullable(clazz.cast(requestPayerAsString()));
case "BypassGovernanceRetention":
return Optional.ofNullable(clazz.cast(bypassGovernanceRetention()));
case "ExpectedBucketOwner":
return Optional.ofNullable(clazz.cast(expectedBucketOwner()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DeleteObjectRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends S3Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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 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.
*
*
* @param 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 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bucket(String bucket);
/**
*
* Key name of the object to delete.
*
*
* @param key
* Key name of the object to delete.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder key(String key);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mfa(String mfa);
/**
*
* VersionId used to reference a specific version of the object.
*
*
* @param versionId
* VersionId used to reference a specific version of the object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder versionId(String versionId);
/**
* Sets the value of the RequestPayer property for this object.
*
* @param requestPayer
* The new value for the RequestPayer property for this object.
* @see RequestPayer
* @return Returns a reference to this object so that method calls can be chained together.
* @see RequestPayer
*/
Builder requestPayer(String requestPayer);
/**
* Sets the value of the RequestPayer property for this object.
*
* @param requestPayer
* The new value for the RequestPayer property for this object.
* @see RequestPayer
* @return Returns a reference to this object so that method calls can be chained together.
* @see RequestPayer
*/
Builder requestPayer(RequestPayer requestPayer);
/**
*
* Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.
*
*
* @param bypassGovernanceRetention
* Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bypassGovernanceRetention(Boolean bypassGovernanceRetention);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expectedBucketOwner(String expectedBucketOwner);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends S3Request.BuilderImpl implements Builder {
private String bucket;
private String key;
private String mfa;
private String versionId;
private String requestPayer;
private Boolean bypassGovernanceRetention;
private String expectedBucketOwner;
private BuilderImpl() {
}
private BuilderImpl(DeleteObjectRequest model) {
super(model);
bucket(model.bucket);
key(model.key);
mfa(model.mfa);
versionId(model.versionId);
requestPayer(model.requestPayer);
bypassGovernanceRetention(model.bypassGovernanceRetention);
expectedBucketOwner(model.expectedBucketOwner);
}
public final String getBucket() {
return bucket;
}
@Override
public final Builder bucket(String bucket) {
this.bucket = bucket;
return this;
}
public final void setBucket(String bucket) {
this.bucket = bucket;
}
public final String getKey() {
return key;
}
@Override
public final Builder key(String key) {
this.key = key;
return this;
}
public final void setKey(String key) {
this.key = key;
}
public final String getMfa() {
return mfa;
}
@Override
public final Builder mfa(String mfa) {
this.mfa = mfa;
return this;
}
public final void setMfa(String mfa) {
this.mfa = mfa;
}
public final String getVersionId() {
return versionId;
}
@Override
public final Builder versionId(String versionId) {
this.versionId = versionId;
return this;
}
public final void setVersionId(String versionId) {
this.versionId = versionId;
}
public final String getRequestPayer() {
return requestPayer;
}
@Override
public final Builder requestPayer(String requestPayer) {
this.requestPayer = requestPayer;
return this;
}
@Override
public final Builder requestPayer(RequestPayer requestPayer) {
this.requestPayer(requestPayer == null ? null : requestPayer.toString());
return this;
}
public final void setRequestPayer(String requestPayer) {
this.requestPayer = requestPayer;
}
public final Boolean getBypassGovernanceRetention() {
return bypassGovernanceRetention;
}
@Override
public final Builder bypassGovernanceRetention(Boolean bypassGovernanceRetention) {
this.bypassGovernanceRetention = bypassGovernanceRetention;
return this;
}
public final void setBypassGovernanceRetention(Boolean bypassGovernanceRetention) {
this.bypassGovernanceRetention = bypassGovernanceRetention;
}
public final String getExpectedBucketOwner() {
return expectedBucketOwner;
}
@Override
public final Builder expectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
return this;
}
public final void setExpectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DeleteObjectRequest build() {
return new DeleteObjectRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}