software.amazon.awssdk.services.s3.model.DeleteObjectResponse Maven / Gradle / Ivy
/*
* 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.Function;
import software.amazon.awssdk.annotations.Generated;
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 DeleteObjectResponse extends S3Response implements
ToCopyableBuilder {
private static final SdkField DELETE_MARKER_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("DeleteMarker")
.getter(getter(DeleteObjectResponse::deleteMarker))
.setter(setter(Builder::deleteMarker))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-delete-marker")
.unmarshallLocationName("x-amz-delete-marker").build()).build();
private static final SdkField VERSION_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("VersionId")
.getter(getter(DeleteObjectResponse::versionId))
.setter(setter(Builder::versionId))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-version-id")
.unmarshallLocationName("x-amz-version-id").build()).build();
private static final SdkField REQUEST_CHARGED_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("RequestCharged")
.getter(getter(DeleteObjectResponse::requestChargedAsString))
.setter(setter(Builder::requestCharged))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-request-charged")
.unmarshallLocationName("x-amz-request-charged").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DELETE_MARKER_FIELD,
VERSION_ID_FIELD, REQUEST_CHARGED_FIELD));
private final Boolean deleteMarker;
private final String versionId;
private final String requestCharged;
private DeleteObjectResponse(BuilderImpl builder) {
super(builder);
this.deleteMarker = builder.deleteMarker;
this.versionId = builder.versionId;
this.requestCharged = builder.requestCharged;
}
/**
*
* Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a
* delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the
* current version of the object is a delete marker.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @return Indicates whether the specified object version that was permanently deleted was (true) or was not (false)
* a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false)
* the current version of the object is a delete marker.
*
* This functionality is not supported for directory buckets.
*
*/
public final Boolean deleteMarker() {
return deleteMarker;
}
/**
*
* Returns the version ID of the delete marker created as a result of the DELETE operation.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @return Returns the version ID of the delete marker created as a result of the DELETE operation.
*
* This functionality is not supported for directory buckets.
*
*/
public final String versionId() {
return versionId;
}
/**
* Returns the value of the RequestCharged property for this object.
*
* If the service returns an enum value that is not available in the current SDK version, {@link #requestCharged}
* will return {@link RequestCharged#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #requestChargedAsString}.
*
*
* @return The value of the RequestCharged property for this object.
* @see RequestCharged
*/
public final RequestCharged requestCharged() {
return RequestCharged.fromValue(requestCharged);
}
/**
* Returns the value of the RequestCharged property for this object.
*
* If the service returns an enum value that is not available in the current SDK version, {@link #requestCharged}
* will return {@link RequestCharged#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #requestChargedAsString}.
*
*
* @return The value of the RequestCharged property for this object.
* @see RequestCharged
*/
public final String requestChargedAsString() {
return requestCharged;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(deleteMarker());
hashCode = 31 * hashCode + Objects.hashCode(versionId());
hashCode = 31 * hashCode + Objects.hashCode(requestChargedAsString());
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 DeleteObjectResponse)) {
return false;
}
DeleteObjectResponse other = (DeleteObjectResponse) obj;
return Objects.equals(deleteMarker(), other.deleteMarker()) && Objects.equals(versionId(), other.versionId())
&& Objects.equals(requestChargedAsString(), other.requestChargedAsString());
}
/**
* 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("DeleteObjectResponse").add("DeleteMarker", deleteMarker()).add("VersionId", versionId())
.add("RequestCharged", requestChargedAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DeleteMarker":
return Optional.ofNullable(clazz.cast(deleteMarker()));
case "VersionId":
return Optional.ofNullable(clazz.cast(versionId()));
case "RequestCharged":
return Optional.ofNullable(clazz.cast(requestChargedAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function