software.amazon.awssdk.services.backup.model.Lifecycle Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of backup Show documentation
Show all versions of backup Show documentation
The AWS Java SDK for Backup module holds the client classes that are used for
communicating with Backup.
/*
* 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.backup.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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;
/**
*
* Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.
*
*
* Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the
* console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition
* to cold after days setting can't be changed after a backup has been transitioned to cold.
*
*
* Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
*
*
* To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for
* MoveToColdStorageAfterDays and DeleteAfterDays.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Lifecycle implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField MOVE_TO_COLD_STORAGE_AFTER_DAYS_FIELD = SdkField
. builder(MarshallingType.LONG)
.memberName("MoveToColdStorageAfterDays")
.getter(getter(Lifecycle::moveToColdStorageAfterDays))
.setter(setter(Builder::moveToColdStorageAfterDays))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MoveToColdStorageAfterDays").build())
.build();
private static final SdkField DELETE_AFTER_DAYS_FIELD = SdkField. builder(MarshallingType.LONG)
.memberName("DeleteAfterDays").getter(getter(Lifecycle::deleteAfterDays)).setter(setter(Builder::deleteAfterDays))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeleteAfterDays").build()).build();
private static final SdkField OPT_IN_TO_ARCHIVE_FOR_SUPPORTED_RESOURCES_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("OptInToArchiveForSupportedResources")
.getter(getter(Lifecycle::optInToArchiveForSupportedResources))
.setter(setter(Builder::optInToArchiveForSupportedResources))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("OptInToArchiveForSupportedResources").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
MOVE_TO_COLD_STORAGE_AFTER_DAYS_FIELD, DELETE_AFTER_DAYS_FIELD, OPT_IN_TO_ARCHIVE_FOR_SUPPORTED_RESOURCES_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final Long moveToColdStorageAfterDays;
private final Long deleteAfterDays;
private final Boolean optInToArchiveForSupportedResources;
private Lifecycle(BuilderImpl builder) {
this.moveToColdStorageAfterDays = builder.moveToColdStorageAfterDays;
this.deleteAfterDays = builder.deleteAfterDays;
this.optInToArchiveForSupportedResources = builder.optInToArchiveForSupportedResources;
}
/**
*
* The number of days after creation that a recovery point is moved to cold storage.
*
*
* @return The number of days after creation that a recovery point is moved to cold storage.
*/
public final Long moveToColdStorageAfterDays() {
return moveToColdStorageAfterDays;
}
/**
*
* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the
* number of days specified in MoveToColdStorageAfterDays.
*
*
* @return The number of days after creation that a recovery point is deleted. This value must be at least 90 days
* after the number of days specified in MoveToColdStorageAfterDays.
*/
public final Long deleteAfterDays() {
return deleteAfterDays;
}
/**
*
* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in
* accordance with your lifecycle settings.
*
*
* @return If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in
* accordance with your lifecycle settings.
*/
public final Boolean optInToArchiveForSupportedResources() {
return optInToArchiveForSupportedResources;
}
@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(moveToColdStorageAfterDays());
hashCode = 31 * hashCode + Objects.hashCode(deleteAfterDays());
hashCode = 31 * hashCode + Objects.hashCode(optInToArchiveForSupportedResources());
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 Lifecycle)) {
return false;
}
Lifecycle other = (Lifecycle) obj;
return Objects.equals(moveToColdStorageAfterDays(), other.moveToColdStorageAfterDays())
&& Objects.equals(deleteAfterDays(), other.deleteAfterDays())
&& Objects.equals(optInToArchiveForSupportedResources(), other.optInToArchiveForSupportedResources());
}
/**
* 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("Lifecycle").add("MoveToColdStorageAfterDays", moveToColdStorageAfterDays())
.add("DeleteAfterDays", deleteAfterDays())
.add("OptInToArchiveForSupportedResources", optInToArchiveForSupportedResources()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "MoveToColdStorageAfterDays":
return Optional.ofNullable(clazz.cast(moveToColdStorageAfterDays()));
case "DeleteAfterDays":
return Optional.ofNullable(clazz.cast(deleteAfterDays()));
case "OptInToArchiveForSupportedResources":
return Optional.ofNullable(clazz.cast(optInToArchiveForSupportedResources()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("MoveToColdStorageAfterDays", MOVE_TO_COLD_STORAGE_AFTER_DAYS_FIELD);
map.put("DeleteAfterDays", DELETE_AFTER_DAYS_FIELD);
map.put("OptInToArchiveForSupportedResources", OPT_IN_TO_ARCHIVE_FOR_SUPPORTED_RESOURCES_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((Lifecycle) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The number of days after creation that a recovery point is moved to cold storage.
*
*
* @param moveToColdStorageAfterDays
* The number of days after creation that a recovery point is moved to cold storage.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder moveToColdStorageAfterDays(Long moveToColdStorageAfterDays);
/**
*
* The number of days after creation that a recovery point is deleted. This value must be at least 90 days after
* the number of days specified in MoveToColdStorageAfterDays.
*
*
* @param deleteAfterDays
* The number of days after creation that a recovery point is deleted. This value must be at least 90
* days after the number of days specified in MoveToColdStorageAfterDays.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deleteAfterDays(Long deleteAfterDays);
/**
*
* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in
* accordance with your lifecycle settings.
*
*
* @param optInToArchiveForSupportedResources
* If the value is true, your backup plan transitions supported resources to archive (cold) storage tier
* in accordance with your lifecycle settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder optInToArchiveForSupportedResources(Boolean optInToArchiveForSupportedResources);
}
static final class BuilderImpl implements Builder {
private Long moveToColdStorageAfterDays;
private Long deleteAfterDays;
private Boolean optInToArchiveForSupportedResources;
private BuilderImpl() {
}
private BuilderImpl(Lifecycle model) {
moveToColdStorageAfterDays(model.moveToColdStorageAfterDays);
deleteAfterDays(model.deleteAfterDays);
optInToArchiveForSupportedResources(model.optInToArchiveForSupportedResources);
}
public final Long getMoveToColdStorageAfterDays() {
return moveToColdStorageAfterDays;
}
public final void setMoveToColdStorageAfterDays(Long moveToColdStorageAfterDays) {
this.moveToColdStorageAfterDays = moveToColdStorageAfterDays;
}
@Override
public final Builder moveToColdStorageAfterDays(Long moveToColdStorageAfterDays) {
this.moveToColdStorageAfterDays = moveToColdStorageAfterDays;
return this;
}
public final Long getDeleteAfterDays() {
return deleteAfterDays;
}
public final void setDeleteAfterDays(Long deleteAfterDays) {
this.deleteAfterDays = deleteAfterDays;
}
@Override
public final Builder deleteAfterDays(Long deleteAfterDays) {
this.deleteAfterDays = deleteAfterDays;
return this;
}
public final Boolean getOptInToArchiveForSupportedResources() {
return optInToArchiveForSupportedResources;
}
public final void setOptInToArchiveForSupportedResources(Boolean optInToArchiveForSupportedResources) {
this.optInToArchiveForSupportedResources = optInToArchiveForSupportedResources;
}
@Override
public final Builder optInToArchiveForSupportedResources(Boolean optInToArchiveForSupportedResources) {
this.optInToArchiveForSupportedResources = optInToArchiveForSupportedResources;
return this;
}
@Override
public Lifecycle build() {
return new Lifecycle(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy