com.amazonaws.services.dlm.model.Schedule Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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;
/**
*
* Specifies a backup schedule.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Schedule implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the schedule.
*
*/
private String name;
/**
*
* Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
*
*/
private Boolean copyTags;
/**
*
* The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle
* tags.
*
*/
private java.util.List tagsToAdd;
/**
*
* A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any
* valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or
* $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
*
*/
private java.util.List variableTags;
/**
*
* The creation rule.
*
*/
private CreateRule createRule;
/**
*
* The retention rule.
*
*/
private RetainRule retainRule;
/**
*
* The rule for enabling fast snapshot restore.
*
*/
private FastRestoreRule fastRestoreRule;
/**
*
* The rule for cross-Region snapshot copies.
*
*/
private java.util.List crossRegionCopyRules;
/**
*
* The name of the schedule.
*
*
* @param name
* The name of the schedule.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the schedule.
*
*
* @return The name of the schedule.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the schedule.
*
*
* @param name
* The name of the schedule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Schedule withName(String name) {
setName(name);
return this;
}
/**
*
* Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
*
*
* @param copyTags
* Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
*/
public void setCopyTags(Boolean copyTags) {
this.copyTags = copyTags;
}
/**
*
* Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
*
*
* @return Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
*/
public Boolean getCopyTags() {
return this.copyTags;
}
/**
*
* Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
*
*
* @param copyTags
* Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Schedule withCopyTags(Boolean copyTags) {
setCopyTags(copyTags);
return this;
}
/**
*
* Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
*
*
* @return Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
*/
public Boolean isCopyTags() {
return this.copyTags;
}
/**
*
* The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle
* tags.
*
*
* @return The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added
* lifecycle tags.
*/
public java.util.List getTagsToAdd() {
return tagsToAdd;
}
/**
*
* The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle
* tags.
*
*
* @param tagsToAdd
* The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added
* lifecycle tags.
*/
public void setTagsToAdd(java.util.Collection tagsToAdd) {
if (tagsToAdd == null) {
this.tagsToAdd = null;
return;
}
this.tagsToAdd = new java.util.ArrayList(tagsToAdd);
}
/**
*
* The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle
* tags.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTagsToAdd(java.util.Collection)} or {@link #withTagsToAdd(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param tagsToAdd
* The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added
* lifecycle tags.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Schedule withTagsToAdd(Tag... tagsToAdd) {
if (this.tagsToAdd == null) {
setTagsToAdd(new java.util.ArrayList(tagsToAdd.length));
}
for (Tag ele : tagsToAdd) {
this.tagsToAdd.add(ele);
}
return this;
}
/**
*
* The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle
* tags.
*
*
* @param tagsToAdd
* The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added
* lifecycle tags.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Schedule withTagsToAdd(java.util.Collection tagsToAdd) {
setTagsToAdd(tagsToAdd);
return this;
}
/**
*
* A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any
* valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or
* $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
*
*
* @return A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may
* be any valid Amazon EC2 tag key. Values must be in one of the two following formats:
* $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot
* Management – Instance policies.
*/
public java.util.List getVariableTags() {
return variableTags;
}
/**
*
* A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any
* valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or
* $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
*
*
* @param variableTags
* A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may
* be any valid Amazon EC2 tag key. Values must be in one of the two following formats:
* $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot
* Management – Instance policies.
*/
public void setVariableTags(java.util.Collection variableTags) {
if (variableTags == null) {
this.variableTags = null;
return;
}
this.variableTags = new java.util.ArrayList(variableTags);
}
/**
*
* A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any
* valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or
* $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setVariableTags(java.util.Collection)} or {@link #withVariableTags(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param variableTags
* A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may
* be any valid Amazon EC2 tag key. Values must be in one of the two following formats:
* $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot
* Management – Instance policies.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Schedule withVariableTags(Tag... variableTags) {
if (this.variableTags == null) {
setVariableTags(new java.util.ArrayList(variableTags.length));
}
for (Tag ele : variableTags) {
this.variableTags.add(ele);
}
return this;
}
/**
*
* A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any
* valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or
* $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
*
*
* @param variableTags
* A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may
* be any valid Amazon EC2 tag key. Values must be in one of the two following formats:
* $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot
* Management – Instance policies.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Schedule withVariableTags(java.util.Collection variableTags) {
setVariableTags(variableTags);
return this;
}
/**
*
* The creation rule.
*
*
* @param createRule
* The creation rule.
*/
public void setCreateRule(CreateRule createRule) {
this.createRule = createRule;
}
/**
*
* The creation rule.
*
*
* @return The creation rule.
*/
public CreateRule getCreateRule() {
return this.createRule;
}
/**
*
* The creation rule.
*
*
* @param createRule
* The creation rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Schedule withCreateRule(CreateRule createRule) {
setCreateRule(createRule);
return this;
}
/**
*
* The retention rule.
*
*
* @param retainRule
* The retention rule.
*/
public void setRetainRule(RetainRule retainRule) {
this.retainRule = retainRule;
}
/**
*
* The retention rule.
*
*
* @return The retention rule.
*/
public RetainRule getRetainRule() {
return this.retainRule;
}
/**
*
* The retention rule.
*
*
* @param retainRule
* The retention rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Schedule withRetainRule(RetainRule retainRule) {
setRetainRule(retainRule);
return this;
}
/**
*
* The rule for enabling fast snapshot restore.
*
*
* @param fastRestoreRule
* The rule for enabling fast snapshot restore.
*/
public void setFastRestoreRule(FastRestoreRule fastRestoreRule) {
this.fastRestoreRule = fastRestoreRule;
}
/**
*
* The rule for enabling fast snapshot restore.
*
*
* @return The rule for enabling fast snapshot restore.
*/
public FastRestoreRule getFastRestoreRule() {
return this.fastRestoreRule;
}
/**
*
* The rule for enabling fast snapshot restore.
*
*
* @param fastRestoreRule
* The rule for enabling fast snapshot restore.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Schedule withFastRestoreRule(FastRestoreRule fastRestoreRule) {
setFastRestoreRule(fastRestoreRule);
return this;
}
/**
*
* The rule for cross-Region snapshot copies.
*
*
* @return The rule for cross-Region snapshot copies.
*/
public java.util.List getCrossRegionCopyRules() {
return crossRegionCopyRules;
}
/**
*
* The rule for cross-Region snapshot copies.
*
*
* @param crossRegionCopyRules
* The rule for cross-Region snapshot copies.
*/
public void setCrossRegionCopyRules(java.util.Collection crossRegionCopyRules) {
if (crossRegionCopyRules == null) {
this.crossRegionCopyRules = null;
return;
}
this.crossRegionCopyRules = new java.util.ArrayList(crossRegionCopyRules);
}
/**
*
* The rule for cross-Region snapshot copies.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCrossRegionCopyRules(java.util.Collection)} or {@link #withCrossRegionCopyRules(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param crossRegionCopyRules
* The rule for cross-Region snapshot copies.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Schedule withCrossRegionCopyRules(CrossRegionCopyRule... crossRegionCopyRules) {
if (this.crossRegionCopyRules == null) {
setCrossRegionCopyRules(new java.util.ArrayList(crossRegionCopyRules.length));
}
for (CrossRegionCopyRule ele : crossRegionCopyRules) {
this.crossRegionCopyRules.add(ele);
}
return this;
}
/**
*
* The rule for cross-Region snapshot copies.
*
*
* @param crossRegionCopyRules
* The rule for cross-Region snapshot copies.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Schedule withCrossRegionCopyRules(java.util.Collection crossRegionCopyRules) {
setCrossRegionCopyRules(crossRegionCopyRules);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getCopyTags() != null)
sb.append("CopyTags: ").append(getCopyTags()).append(",");
if (getTagsToAdd() != null)
sb.append("TagsToAdd: ").append(getTagsToAdd()).append(",");
if (getVariableTags() != null)
sb.append("VariableTags: ").append(getVariableTags()).append(",");
if (getCreateRule() != null)
sb.append("CreateRule: ").append(getCreateRule()).append(",");
if (getRetainRule() != null)
sb.append("RetainRule: ").append(getRetainRule()).append(",");
if (getFastRestoreRule() != null)
sb.append("FastRestoreRule: ").append(getFastRestoreRule()).append(",");
if (getCrossRegionCopyRules() != null)
sb.append("CrossRegionCopyRules: ").append(getCrossRegionCopyRules());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Schedule == false)
return false;
Schedule other = (Schedule) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getCopyTags() == null ^ this.getCopyTags() == null)
return false;
if (other.getCopyTags() != null && other.getCopyTags().equals(this.getCopyTags()) == false)
return false;
if (other.getTagsToAdd() == null ^ this.getTagsToAdd() == null)
return false;
if (other.getTagsToAdd() != null && other.getTagsToAdd().equals(this.getTagsToAdd()) == false)
return false;
if (other.getVariableTags() == null ^ this.getVariableTags() == null)
return false;
if (other.getVariableTags() != null && other.getVariableTags().equals(this.getVariableTags()) == false)
return false;
if (other.getCreateRule() == null ^ this.getCreateRule() == null)
return false;
if (other.getCreateRule() != null && other.getCreateRule().equals(this.getCreateRule()) == false)
return false;
if (other.getRetainRule() == null ^ this.getRetainRule() == null)
return false;
if (other.getRetainRule() != null && other.getRetainRule().equals(this.getRetainRule()) == false)
return false;
if (other.getFastRestoreRule() == null ^ this.getFastRestoreRule() == null)
return false;
if (other.getFastRestoreRule() != null && other.getFastRestoreRule().equals(this.getFastRestoreRule()) == false)
return false;
if (other.getCrossRegionCopyRules() == null ^ this.getCrossRegionCopyRules() == null)
return false;
if (other.getCrossRegionCopyRules() != null && other.getCrossRegionCopyRules().equals(this.getCrossRegionCopyRules()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getCopyTags() == null) ? 0 : getCopyTags().hashCode());
hashCode = prime * hashCode + ((getTagsToAdd() == null) ? 0 : getTagsToAdd().hashCode());
hashCode = prime * hashCode + ((getVariableTags() == null) ? 0 : getVariableTags().hashCode());
hashCode = prime * hashCode + ((getCreateRule() == null) ? 0 : getCreateRule().hashCode());
hashCode = prime * hashCode + ((getRetainRule() == null) ? 0 : getRetainRule().hashCode());
hashCode = prime * hashCode + ((getFastRestoreRule() == null) ? 0 : getFastRestoreRule().hashCode());
hashCode = prime * hashCode + ((getCrossRegionCopyRules() == null) ? 0 : getCrossRegionCopyRules().hashCode());
return hashCode;
}
@Override
public Schedule clone() {
try {
return (Schedule) 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.ScheduleMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}