software.amazon.awssdk.services.s3.model.VersioningConfiguration 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.io.Serializable;
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;
/**
*
* Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning
* in the Amazon Simple Storage Service API Reference.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class VersioningConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField MFA_DELETE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("MFADelete")
.getter(getter(VersioningConfiguration::mfaDeleteAsString))
.setter(setter(Builder::mfaDelete))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MfaDelete")
.unmarshallLocationName("MfaDelete").build()).build();
private static final SdkField STATUS_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Status")
.getter(getter(VersioningConfiguration::statusAsString))
.setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status")
.unmarshallLocationName("Status").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays
.asList(MFA_DELETE_FIELD, STATUS_FIELD));
private static final long serialVersionUID = 1L;
private final String mfaDelete;
private final String status;
private VersioningConfiguration(BuilderImpl builder) {
this.mfaDelete = builder.mfaDelete;
this.status = builder.status;
}
/**
*
* Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if
* the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not
* returned.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mfaDelete} will
* return {@link MFADelete#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #mfaDeleteAsString}.
*
*
* @return Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only
* returned if the bucket has been configured with MFA delete. If the bucket has never been so configured,
* this element is not returned.
* @see MFADelete
*/
public MFADelete mfaDelete() {
return MFADelete.fromValue(mfaDelete);
}
/**
*
* Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if
* the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not
* returned.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mfaDelete} will
* return {@link MFADelete#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #mfaDeleteAsString}.
*
*
* @return Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only
* returned if the bucket has been configured with MFA delete. If the bucket has never been so configured,
* this element is not returned.
* @see MFADelete
*/
public String mfaDeleteAsString() {
return mfaDelete;
}
/**
*
* The versioning state of the bucket.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link BucketVersioningStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return The versioning state of the bucket.
* @see BucketVersioningStatus
*/
public BucketVersioningStatus status() {
return BucketVersioningStatus.fromValue(status);
}
/**
*
* The versioning state of the bucket.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link BucketVersioningStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return The versioning state of the bucket.
* @see BucketVersioningStatus
*/
public String statusAsString() {
return status;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(mfaDeleteAsString());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof VersioningConfiguration)) {
return false;
}
VersioningConfiguration other = (VersioningConfiguration) obj;
return Objects.equals(mfaDeleteAsString(), other.mfaDeleteAsString())
&& Objects.equals(statusAsString(), other.statusAsString());
}
/**
* 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 String toString() {
return ToString.builder("VersioningConfiguration").add("MFADelete", mfaDeleteAsString()).add("Status", statusAsString())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "MFADelete":
return Optional.ofNullable(clazz.cast(mfaDeleteAsString()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((VersioningConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned
* if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element
* is not returned.
*
*
* @param mfaDelete
* Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only
* returned if the bucket has been configured with MFA delete. If the bucket has never been so
* configured, this element is not returned.
* @see MFADelete
* @return Returns a reference to this object so that method calls can be chained together.
* @see MFADelete
*/
Builder mfaDelete(String mfaDelete);
/**
*
* Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned
* if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element
* is not returned.
*
*
* @param mfaDelete
* Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only
* returned if the bucket has been configured with MFA delete. If the bucket has never been so
* configured, this element is not returned.
* @see MFADelete
* @return Returns a reference to this object so that method calls can be chained together.
* @see MFADelete
*/
Builder mfaDelete(MFADelete mfaDelete);
/**
*
* The versioning state of the bucket.
*
*
* @param status
* The versioning state of the bucket.
* @see BucketVersioningStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see BucketVersioningStatus
*/
Builder status(String status);
/**
*
* The versioning state of the bucket.
*
*
* @param status
* The versioning state of the bucket.
* @see BucketVersioningStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see BucketVersioningStatus
*/
Builder status(BucketVersioningStatus status);
}
static final class BuilderImpl implements Builder {
private String mfaDelete;
private String status;
private BuilderImpl() {
}
private BuilderImpl(VersioningConfiguration model) {
mfaDelete(model.mfaDelete);
status(model.status);
}
public final String getMfaDelete() {
return mfaDelete;
}
@Override
public final Builder mfaDelete(String mfaDelete) {
this.mfaDelete = mfaDelete;
return this;
}
@Override
public final Builder mfaDelete(MFADelete mfaDelete) {
this.mfaDelete(mfaDelete == null ? null : mfaDelete.toString());
return this;
}
public final void setMfaDelete(String mfaDelete) {
this.mfaDelete = mfaDelete;
}
public final String getStatus() {
return status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(BucketVersioningStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public VersioningConfiguration build() {
return new VersioningConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}