software.amazon.awssdk.services.s3.model.NoncurrentVersionTransition 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;
/**
*
* Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA,
* ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or
* DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can
* set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA,
* ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or
* DEEP_ARCHIVE storage class at a specific period in the object's lifetime.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class NoncurrentVersionTransition implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NONCURRENT_DAYS_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("NoncurrentDays")
.getter(getter(NoncurrentVersionTransition::noncurrentDays))
.setter(setter(Builder::noncurrentDays))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NoncurrentDays")
.unmarshallLocationName("NoncurrentDays").build()).build();
private static final SdkField STORAGE_CLASS_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("StorageClass")
.getter(getter(NoncurrentVersionTransition::storageClassAsString))
.setter(setter(Builder::storageClass))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StorageClass")
.unmarshallLocationName("StorageClass").build()).build();
private static final SdkField NEWER_NONCURRENT_VERSIONS_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("NewerNoncurrentVersions")
.getter(getter(NoncurrentVersionTransition::newerNoncurrentVersions))
.setter(setter(Builder::newerNoncurrentVersions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NewerNoncurrentVersions")
.unmarshallLocationName("NewerNoncurrentVersions").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NONCURRENT_DAYS_FIELD,
STORAGE_CLASS_FIELD, NEWER_NONCURRENT_VERSIONS_FIELD));
private static final long serialVersionUID = 1L;
private final Integer noncurrentDays;
private final String storageClass;
private final Integer newerNoncurrentVersions;
private NoncurrentVersionTransition(BuilderImpl builder) {
this.noncurrentDays = builder.noncurrentDays;
this.storageClass = builder.storageClass;
this.newerNoncurrentVersions = builder.newerNoncurrentVersions;
}
/**
*
* Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For
* information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.
*
*
* @return Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action.
* For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.
*/
public final Integer noncurrentDays() {
return noncurrentDays;
}
/**
*
* The class of storage used to store the object.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #storageClass} will
* return {@link TransitionStorageClass#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #storageClassAsString}.
*
*
* @return The class of storage used to store the object.
* @see TransitionStorageClass
*/
public final TransitionStorageClass storageClass() {
return TransitionStorageClass.fromValue(storageClass);
}
/**
*
* The class of storage used to store the object.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #storageClass} will
* return {@link TransitionStorageClass#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #storageClassAsString}.
*
*
* @return The class of storage used to store the object.
* @see TransitionStorageClass
*/
public final String storageClassAsString() {
return storageClass;
}
/**
*
* Specifies how many newer noncurrent versions must exist before Amazon S3 can perform the associated action on a
* given version. If there are this many more recent noncurrent versions, Amazon S3 will take the associated action.
* For more information about noncurrent versions, see Lifecycle configuration
* elements in the Amazon S3 User Guide.
*
*
* @return Specifies how many newer noncurrent versions must exist before Amazon S3 can perform the associated
* action on a given version. If there are this many more recent noncurrent versions, Amazon S3 will take
* the associated action. For more information about noncurrent versions, see Lifecycle
* configuration elements in the Amazon S3 User Guide.
*/
public final Integer newerNoncurrentVersions() {
return newerNoncurrentVersions;
}
@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 + Objects.hashCode(noncurrentDays());
hashCode = 31 * hashCode + Objects.hashCode(storageClassAsString());
hashCode = 31 * hashCode + Objects.hashCode(newerNoncurrentVersions());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof NoncurrentVersionTransition)) {
return false;
}
NoncurrentVersionTransition other = (NoncurrentVersionTransition) obj;
return Objects.equals(noncurrentDays(), other.noncurrentDays())
&& Objects.equals(storageClassAsString(), other.storageClassAsString())
&& Objects.equals(newerNoncurrentVersions(), other.newerNoncurrentVersions());
}
/**
* 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("NoncurrentVersionTransition").add("NoncurrentDays", noncurrentDays())
.add("StorageClass", storageClassAsString()).add("NewerNoncurrentVersions", newerNoncurrentVersions()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NoncurrentDays":
return Optional.ofNullable(clazz.cast(noncurrentDays()));
case "StorageClass":
return Optional.ofNullable(clazz.cast(storageClassAsString()));
case "NewerNoncurrentVersions":
return Optional.ofNullable(clazz.cast(newerNoncurrentVersions()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((NoncurrentVersionTransition) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For
* information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.
*
*
* @param noncurrentDays
* Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated
* action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User
* Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder noncurrentDays(Integer noncurrentDays);
/**
*
* The class of storage used to store the object.
*
*
* @param storageClass
* The class of storage used to store the object.
* @see TransitionStorageClass
* @return Returns a reference to this object so that method calls can be chained together.
* @see TransitionStorageClass
*/
Builder storageClass(String storageClass);
/**
*
* The class of storage used to store the object.
*
*
* @param storageClass
* The class of storage used to store the object.
* @see TransitionStorageClass
* @return Returns a reference to this object so that method calls can be chained together.
* @see TransitionStorageClass
*/
Builder storageClass(TransitionStorageClass storageClass);
/**
*
* Specifies how many newer noncurrent versions must exist before Amazon S3 can perform the associated action on
* a given version. If there are this many more recent noncurrent versions, Amazon S3 will take the associated
* action. For more information about noncurrent versions, see Lifecycle
* configuration elements in the Amazon S3 User Guide.
*
*
* @param newerNoncurrentVersions
* Specifies how many newer noncurrent versions must exist before Amazon S3 can perform the associated
* action on a given version. If there are this many more recent noncurrent versions, Amazon S3 will take
* the associated action. For more information about noncurrent versions, see Lifecycle
* configuration elements in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder newerNoncurrentVersions(Integer newerNoncurrentVersions);
}
static final class BuilderImpl implements Builder {
private Integer noncurrentDays;
private String storageClass;
private Integer newerNoncurrentVersions;
private BuilderImpl() {
}
private BuilderImpl(NoncurrentVersionTransition model) {
noncurrentDays(model.noncurrentDays);
storageClass(model.storageClass);
newerNoncurrentVersions(model.newerNoncurrentVersions);
}
public final Integer getNoncurrentDays() {
return noncurrentDays;
}
public final void setNoncurrentDays(Integer noncurrentDays) {
this.noncurrentDays = noncurrentDays;
}
@Override
public final Builder noncurrentDays(Integer noncurrentDays) {
this.noncurrentDays = noncurrentDays;
return this;
}
public final String getStorageClass() {
return storageClass;
}
public final void setStorageClass(String storageClass) {
this.storageClass = storageClass;
}
@Override
public final Builder storageClass(String storageClass) {
this.storageClass = storageClass;
return this;
}
@Override
public final Builder storageClass(TransitionStorageClass storageClass) {
this.storageClass(storageClass == null ? null : storageClass.toString());
return this;
}
public final Integer getNewerNoncurrentVersions() {
return newerNoncurrentVersions;
}
public final void setNewerNoncurrentVersions(Integer newerNoncurrentVersions) {
this.newerNoncurrentVersions = newerNoncurrentVersions;
}
@Override
public final Builder newerNoncurrentVersions(Integer newerNoncurrentVersions) {
this.newerNoncurrentVersions = newerNoncurrentVersions;
return this;
}
@Override
public NoncurrentVersionTransition build() {
return new NoncurrentVersionTransition(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}