com.amazonaws.services.ec2.model.RestoreSnapshotTierRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2018-2023 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.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.RestoreSnapshotTierRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RestoreSnapshotTierRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The ID of the snapshot to restore.
*
*/
private String snapshotId;
/**
*
* Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary
* restores only. The snapshot will be automatically re-archived after this period.
*
*
* To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore
* parameter or set it to false.
*
*/
private Integer temporaryRestoreDays;
/**
*
* Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot,
* specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.
*
*/
private Boolean permanentRestore;
/**
*
* The ID of the snapshot to restore.
*
*
* @param snapshotId
* The ID of the snapshot to restore.
*/
public void setSnapshotId(String snapshotId) {
this.snapshotId = snapshotId;
}
/**
*
* The ID of the snapshot to restore.
*
*
* @return The ID of the snapshot to restore.
*/
public String getSnapshotId() {
return this.snapshotId;
}
/**
*
* The ID of the snapshot to restore.
*
*
* @param snapshotId
* The ID of the snapshot to restore.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreSnapshotTierRequest withSnapshotId(String snapshotId) {
setSnapshotId(snapshotId);
return this;
}
/**
*
* Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary
* restores only. The snapshot will be automatically re-archived after this period.
*
*
* To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore
* parameter or set it to false.
*
*
* @param temporaryRestoreDays
* Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary
* restores only. The snapshot will be automatically re-archived after this period.
*
* To temporarily restore an archived snapshot, specify the number of days and omit the
* PermanentRestore parameter or set it to false.
*/
public void setTemporaryRestoreDays(Integer temporaryRestoreDays) {
this.temporaryRestoreDays = temporaryRestoreDays;
}
/**
*
* Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary
* restores only. The snapshot will be automatically re-archived after this period.
*
*
* To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore
* parameter or set it to false.
*
*
* @return Specifies the number of days for which to temporarily restore an archived snapshot. Required for
* temporary restores only. The snapshot will be automatically re-archived after this period.
*
* To temporarily restore an archived snapshot, specify the number of days and omit the
* PermanentRestore parameter or set it to false.
*/
public Integer getTemporaryRestoreDays() {
return this.temporaryRestoreDays;
}
/**
*
* Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary
* restores only. The snapshot will be automatically re-archived after this period.
*
*
* To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore
* parameter or set it to false.
*
*
* @param temporaryRestoreDays
* Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary
* restores only. The snapshot will be automatically re-archived after this period.
*
* To temporarily restore an archived snapshot, specify the number of days and omit the
* PermanentRestore parameter or set it to false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreSnapshotTierRequest withTemporaryRestoreDays(Integer temporaryRestoreDays) {
setTemporaryRestoreDays(temporaryRestoreDays);
return this;
}
/**
*
* Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot,
* specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.
*
*
* @param permanentRestore
* Indicates whether to permanently restore an archived snapshot. To permanently restore an archived
* snapshot, specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays
* parameter.
*/
public void setPermanentRestore(Boolean permanentRestore) {
this.permanentRestore = permanentRestore;
}
/**
*
* Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot,
* specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.
*
*
* @return Indicates whether to permanently restore an archived snapshot. To permanently restore an archived
* snapshot, specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays
* parameter.
*/
public Boolean getPermanentRestore() {
return this.permanentRestore;
}
/**
*
* Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot,
* specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.
*
*
* @param permanentRestore
* Indicates whether to permanently restore an archived snapshot. To permanently restore an archived
* snapshot, specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays
* parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RestoreSnapshotTierRequest withPermanentRestore(Boolean permanentRestore) {
setPermanentRestore(permanentRestore);
return this;
}
/**
*
* Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot,
* specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.
*
*
* @return Indicates whether to permanently restore an archived snapshot. To permanently restore an archived
* snapshot, specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays
* parameter.
*/
public Boolean isPermanentRestore() {
return this.permanentRestore;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new RestoreSnapshotTierRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getSnapshotId() != null)
sb.append("SnapshotId: ").append(getSnapshotId()).append(",");
if (getTemporaryRestoreDays() != null)
sb.append("TemporaryRestoreDays: ").append(getTemporaryRestoreDays()).append(",");
if (getPermanentRestore() != null)
sb.append("PermanentRestore: ").append(getPermanentRestore());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RestoreSnapshotTierRequest == false)
return false;
RestoreSnapshotTierRequest other = (RestoreSnapshotTierRequest) obj;
if (other.getSnapshotId() == null ^ this.getSnapshotId() == null)
return false;
if (other.getSnapshotId() != null && other.getSnapshotId().equals(this.getSnapshotId()) == false)
return false;
if (other.getTemporaryRestoreDays() == null ^ this.getTemporaryRestoreDays() == null)
return false;
if (other.getTemporaryRestoreDays() != null && other.getTemporaryRestoreDays().equals(this.getTemporaryRestoreDays()) == false)
return false;
if (other.getPermanentRestore() == null ^ this.getPermanentRestore() == null)
return false;
if (other.getPermanentRestore() != null && other.getPermanentRestore().equals(this.getPermanentRestore()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSnapshotId() == null) ? 0 : getSnapshotId().hashCode());
hashCode = prime * hashCode + ((getTemporaryRestoreDays() == null) ? 0 : getTemporaryRestoreDays().hashCode());
hashCode = prime * hashCode + ((getPermanentRestore() == null) ? 0 : getPermanentRestore().hashCode());
return hashCode;
}
@Override
public RestoreSnapshotTierRequest clone() {
return (RestoreSnapshotTierRequest) super.clone();
}
}