com.amazonaws.services.dlm.model.RetainRule Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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 com.amazonaws.services.dlm.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* [Custom snapshot and AMI policies only] Specifies a retention rule for snapshots created by snapshot policies,
* or for AMIs created by AMI policies.
*
*
*
* For snapshot policies that have an ArchiveRule, this retention rule
* applies to standard tier retention. When the retention threshold is met, snapshots are moved from the standard to the
* archive tier.
*
*
* For snapshot policies that do not have an ArchiveRule, snapshots are permanently deleted when this retention
* threshold is met.
*
*
*
* You can retain snapshots based on either a count or a time interval.
*
*
* -
*
* Count-based retention
*
*
* You must specify Count. If you specify an ArchiveRule for the schedule,
* then you can specify a retention count of 0 to archive snapshots immediately after creation. If you
* specify a FastRestoreRule,
* ShareRule, or a CrossRegionCopyRule, then
* you must specify a retention count of 1 or more.
*
*
* -
*
* Age-based retention
*
*
* You must specify Interval and IntervalUnit. If you specify an ArchiveRule for the schedule,
* then you can specify a retention interval of 0 days to archive snapshots immediately after creation. If
* you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then
* you must specify a retention interval of 1 day or more.
*
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RetainRule implements Serializable, Cloneable, StructuredPojo {
/**
*
* The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a
* maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained
* snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
*
*/
private Integer count;
/**
*
* The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200
* weeks, or 36500 days.
*
*/
private Integer interval;
/**
*
* The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify
* Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months,
* it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
*
*/
private String intervalUnit;
/**
*
* The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a
* maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained
* snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
*
*
* @param count
* The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to
* retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the
* oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
*/
public void setCount(Integer count) {
this.count = count;
}
/**
*
* The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a
* maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained
* snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
*
*
* @return The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to
* retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the
* oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
*/
public Integer getCount() {
return this.count;
}
/**
*
* The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a
* maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained
* snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
*
*
* @param count
* The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to
* retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the
* oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RetainRule withCount(Integer count) {
setCount(count);
return this;
}
/**
*
* The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200
* weeks, or 36500 days.
*
*
* @param interval
* The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months,
* 5200 weeks, or 36500 days.
*/
public void setInterval(Integer interval) {
this.interval = interval;
}
/**
*
* The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200
* weeks, or 36500 days.
*
*
* @return The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months,
* 5200 weeks, or 36500 days.
*/
public Integer getInterval() {
return this.interval;
}
/**
*
* The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200
* weeks, or 36500 days.
*
*
* @param interval
* The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months,
* 5200 weeks, or 36500 days.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RetainRule withInterval(Integer interval) {
setInterval(interval);
return this;
}
/**
*
* The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify
* Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months,
* it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
*
*
* @param intervalUnit
* The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify
* Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3
* months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
* @see RetentionIntervalUnitValues
*/
public void setIntervalUnit(String intervalUnit) {
this.intervalUnit = intervalUnit;
}
/**
*
* The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify
* Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months,
* it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
*
*
* @return The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify
* Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3
* months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
* @see RetentionIntervalUnitValues
*/
public String getIntervalUnit() {
return this.intervalUnit;
}
/**
*
* The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify
* Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months,
* it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
*
*
* @param intervalUnit
* The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify
* Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3
* months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RetentionIntervalUnitValues
*/
public RetainRule withIntervalUnit(String intervalUnit) {
setIntervalUnit(intervalUnit);
return this;
}
/**
*
* The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify
* Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months,
* it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
*
*
* @param intervalUnit
* The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify
* Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3
* months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RetentionIntervalUnitValues
*/
public RetainRule withIntervalUnit(RetentionIntervalUnitValues intervalUnit) {
this.intervalUnit = intervalUnit.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCount() != null)
sb.append("Count: ").append(getCount()).append(",");
if (getInterval() != null)
sb.append("Interval: ").append(getInterval()).append(",");
if (getIntervalUnit() != null)
sb.append("IntervalUnit: ").append(getIntervalUnit());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RetainRule == false)
return false;
RetainRule other = (RetainRule) obj;
if (other.getCount() == null ^ this.getCount() == null)
return false;
if (other.getCount() != null && other.getCount().equals(this.getCount()) == false)
return false;
if (other.getInterval() == null ^ this.getInterval() == null)
return false;
if (other.getInterval() != null && other.getInterval().equals(this.getInterval()) == false)
return false;
if (other.getIntervalUnit() == null ^ this.getIntervalUnit() == null)
return false;
if (other.getIntervalUnit() != null && other.getIntervalUnit().equals(this.getIntervalUnit()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCount() == null) ? 0 : getCount().hashCode());
hashCode = prime * hashCode + ((getInterval() == null) ? 0 : getInterval().hashCode());
hashCode = prime * hashCode + ((getIntervalUnit() == null) ? 0 : getIntervalUnit().hashCode());
return hashCode;
}
@Override
public RetainRule clone() {
try {
return (RetainRule) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.dlm.model.transform.RetainRuleMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}