com.amazonaws.services.lightsail.model.DiskSnapshot Maven / Gradle / Ivy
/*
* 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.lightsail.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes a block storage disk snapshot.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DiskSnapshot implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the disk snapshot (e.g., my-disk-snapshot).
*
*/
private String name;
/**
*
* The Amazon Resource Name (ARN) of the disk snapshot.
*
*/
private String arn;
/**
*
* The support code. Include this code in your email to support when you have questions about an instance or another
* resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*
*/
private String supportCode;
/**
*
* The date when the disk snapshot was created.
*
*/
private java.util.Date createdAt;
/**
*
* The AWS Region and Availability Zone where the disk snapshot was created.
*
*/
private ResourceLocation location;
/**
*
* The Lightsail resource type (e.g., DiskSnapshot).
*
*/
private String resourceType;
/**
*
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer
* Guide.
*
*/
private java.util.List tags;
/**
*
* The size of the disk in GB.
*
*/
private Integer sizeInGb;
/**
*
* The status of the disk snapshot operation.
*
*/
private String state;
/**
*
* The progress of the snapshot.
*
*/
private String progress;
/**
*
* The unique name of the source disk from which the disk snapshot was created.
*
*/
private String fromDiskName;
/**
*
* The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
*
*/
private String fromDiskArn;
/**
*
* The unique name of the source instance from which the disk (system volume) snapshot was created.
*
*/
private String fromInstanceName;
/**
*
* The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
*
*/
private String fromInstanceArn;
/**
*
* A Boolean value indicating whether the snapshot was created from an automatic snapshot.
*
*/
private Boolean isFromAutoSnapshot;
/**
*
* The name of the disk snapshot (e.g., my-disk-snapshot).
*
*
* @param name
* The name of the disk snapshot (e.g., my-disk-snapshot).
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the disk snapshot (e.g., my-disk-snapshot).
*
*
* @return The name of the disk snapshot (e.g., my-disk-snapshot).
*/
public String getName() {
return this.name;
}
/**
*
* The name of the disk snapshot (e.g., my-disk-snapshot).
*
*
* @param name
* The name of the disk snapshot (e.g., my-disk-snapshot).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withName(String name) {
setName(name);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the disk snapshot.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the disk snapshot.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) of the disk snapshot.
*
*
* @return The Amazon Resource Name (ARN) of the disk snapshot.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) of the disk snapshot.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the disk snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The support code. Include this code in your email to support when you have questions about an instance or another
* resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*
*
* @param supportCode
* The support code. Include this code in your email to support when you have questions about an instance or
* another resource in Lightsail. This code enables our support team to look up your Lightsail information
* more easily.
*/
public void setSupportCode(String supportCode) {
this.supportCode = supportCode;
}
/**
*
* The support code. Include this code in your email to support when you have questions about an instance or another
* resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*
*
* @return The support code. Include this code in your email to support when you have questions about an instance or
* another resource in Lightsail. This code enables our support team to look up your Lightsail information
* more easily.
*/
public String getSupportCode() {
return this.supportCode;
}
/**
*
* The support code. Include this code in your email to support when you have questions about an instance or another
* resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*
*
* @param supportCode
* The support code. Include this code in your email to support when you have questions about an instance or
* another resource in Lightsail. This code enables our support team to look up your Lightsail information
* more easily.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withSupportCode(String supportCode) {
setSupportCode(supportCode);
return this;
}
/**
*
* The date when the disk snapshot was created.
*
*
* @param createdAt
* The date when the disk snapshot was created.
*/
public void setCreatedAt(java.util.Date createdAt) {
this.createdAt = createdAt;
}
/**
*
* The date when the disk snapshot was created.
*
*
* @return The date when the disk snapshot was created.
*/
public java.util.Date getCreatedAt() {
return this.createdAt;
}
/**
*
* The date when the disk snapshot was created.
*
*
* @param createdAt
* The date when the disk snapshot was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withCreatedAt(java.util.Date createdAt) {
setCreatedAt(createdAt);
return this;
}
/**
*
* The AWS Region and Availability Zone where the disk snapshot was created.
*
*
* @param location
* The AWS Region and Availability Zone where the disk snapshot was created.
*/
public void setLocation(ResourceLocation location) {
this.location = location;
}
/**
*
* The AWS Region and Availability Zone where the disk snapshot was created.
*
*
* @return The AWS Region and Availability Zone where the disk snapshot was created.
*/
public ResourceLocation getLocation() {
return this.location;
}
/**
*
* The AWS Region and Availability Zone where the disk snapshot was created.
*
*
* @param location
* The AWS Region and Availability Zone where the disk snapshot was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withLocation(ResourceLocation location) {
setLocation(location);
return this;
}
/**
*
* The Lightsail resource type (e.g., DiskSnapshot).
*
*
* @param resourceType
* The Lightsail resource type (e.g., DiskSnapshot).
* @see ResourceType
*/
public void setResourceType(String resourceType) {
this.resourceType = resourceType;
}
/**
*
* The Lightsail resource type (e.g., DiskSnapshot).
*
*
* @return The Lightsail resource type (e.g., DiskSnapshot).
* @see ResourceType
*/
public String getResourceType() {
return this.resourceType;
}
/**
*
* The Lightsail resource type (e.g., DiskSnapshot).
*
*
* @param resourceType
* The Lightsail resource type (e.g., DiskSnapshot).
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceType
*/
public DiskSnapshot withResourceType(String resourceType) {
setResourceType(resourceType);
return this;
}
/**
*
* The Lightsail resource type (e.g., DiskSnapshot).
*
*
* @param resourceType
* The Lightsail resource type (e.g., DiskSnapshot).
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceType
*/
public DiskSnapshot withResourceType(ResourceType resourceType) {
this.resourceType = resourceType.toString();
return this;
}
/**
*
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer
* Guide.
*
*
* @return The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
* Amazon Lightsail
* Developer Guide.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer
* Guide.
*
*
* @param tags
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
* Amazon Lightsail
* Developer Guide.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer
* Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
* Amazon Lightsail
* Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer
* Guide.
*
*
* @param tags
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
* Amazon Lightsail
* Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The size of the disk in GB.
*
*
* @param sizeInGb
* The size of the disk in GB.
*/
public void setSizeInGb(Integer sizeInGb) {
this.sizeInGb = sizeInGb;
}
/**
*
* The size of the disk in GB.
*
*
* @return The size of the disk in GB.
*/
public Integer getSizeInGb() {
return this.sizeInGb;
}
/**
*
* The size of the disk in GB.
*
*
* @param sizeInGb
* The size of the disk in GB.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withSizeInGb(Integer sizeInGb) {
setSizeInGb(sizeInGb);
return this;
}
/**
*
* The status of the disk snapshot operation.
*
*
* @param state
* The status of the disk snapshot operation.
* @see DiskSnapshotState
*/
public void setState(String state) {
this.state = state;
}
/**
*
* The status of the disk snapshot operation.
*
*
* @return The status of the disk snapshot operation.
* @see DiskSnapshotState
*/
public String getState() {
return this.state;
}
/**
*
* The status of the disk snapshot operation.
*
*
* @param state
* The status of the disk snapshot operation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DiskSnapshotState
*/
public DiskSnapshot withState(String state) {
setState(state);
return this;
}
/**
*
* The status of the disk snapshot operation.
*
*
* @param state
* The status of the disk snapshot operation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DiskSnapshotState
*/
public DiskSnapshot withState(DiskSnapshotState state) {
this.state = state.toString();
return this;
}
/**
*
* The progress of the snapshot.
*
*
* @param progress
* The progress of the snapshot.
*/
public void setProgress(String progress) {
this.progress = progress;
}
/**
*
* The progress of the snapshot.
*
*
* @return The progress of the snapshot.
*/
public String getProgress() {
return this.progress;
}
/**
*
* The progress of the snapshot.
*
*
* @param progress
* The progress of the snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withProgress(String progress) {
setProgress(progress);
return this;
}
/**
*
* The unique name of the source disk from which the disk snapshot was created.
*
*
* @param fromDiskName
* The unique name of the source disk from which the disk snapshot was created.
*/
public void setFromDiskName(String fromDiskName) {
this.fromDiskName = fromDiskName;
}
/**
*
* The unique name of the source disk from which the disk snapshot was created.
*
*
* @return The unique name of the source disk from which the disk snapshot was created.
*/
public String getFromDiskName() {
return this.fromDiskName;
}
/**
*
* The unique name of the source disk from which the disk snapshot was created.
*
*
* @param fromDiskName
* The unique name of the source disk from which the disk snapshot was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withFromDiskName(String fromDiskName) {
setFromDiskName(fromDiskName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
*
*
* @param fromDiskArn
* The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
*/
public void setFromDiskArn(String fromDiskArn) {
this.fromDiskArn = fromDiskArn;
}
/**
*
* The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
*
*
* @return The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
*/
public String getFromDiskArn() {
return this.fromDiskArn;
}
/**
*
* The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
*
*
* @param fromDiskArn
* The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withFromDiskArn(String fromDiskArn) {
setFromDiskArn(fromDiskArn);
return this;
}
/**
*
* The unique name of the source instance from which the disk (system volume) snapshot was created.
*
*
* @param fromInstanceName
* The unique name of the source instance from which the disk (system volume) snapshot was created.
*/
public void setFromInstanceName(String fromInstanceName) {
this.fromInstanceName = fromInstanceName;
}
/**
*
* The unique name of the source instance from which the disk (system volume) snapshot was created.
*
*
* @return The unique name of the source instance from which the disk (system volume) snapshot was created.
*/
public String getFromInstanceName() {
return this.fromInstanceName;
}
/**
*
* The unique name of the source instance from which the disk (system volume) snapshot was created.
*
*
* @param fromInstanceName
* The unique name of the source instance from which the disk (system volume) snapshot was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withFromInstanceName(String fromInstanceName) {
setFromInstanceName(fromInstanceName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
*
*
* @param fromInstanceArn
* The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was
* created.
*/
public void setFromInstanceArn(String fromInstanceArn) {
this.fromInstanceArn = fromInstanceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
*
*
* @return The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was
* created.
*/
public String getFromInstanceArn() {
return this.fromInstanceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
*
*
* @param fromInstanceArn
* The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was
* created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withFromInstanceArn(String fromInstanceArn) {
setFromInstanceArn(fromInstanceArn);
return this;
}
/**
*
* A Boolean value indicating whether the snapshot was created from an automatic snapshot.
*
*
* @param isFromAutoSnapshot
* A Boolean value indicating whether the snapshot was created from an automatic snapshot.
*/
public void setIsFromAutoSnapshot(Boolean isFromAutoSnapshot) {
this.isFromAutoSnapshot = isFromAutoSnapshot;
}
/**
*
* A Boolean value indicating whether the snapshot was created from an automatic snapshot.
*
*
* @return A Boolean value indicating whether the snapshot was created from an automatic snapshot.
*/
public Boolean getIsFromAutoSnapshot() {
return this.isFromAutoSnapshot;
}
/**
*
* A Boolean value indicating whether the snapshot was created from an automatic snapshot.
*
*
* @param isFromAutoSnapshot
* A Boolean value indicating whether the snapshot was created from an automatic snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DiskSnapshot withIsFromAutoSnapshot(Boolean isFromAutoSnapshot) {
setIsFromAutoSnapshot(isFromAutoSnapshot);
return this;
}
/**
*
* A Boolean value indicating whether the snapshot was created from an automatic snapshot.
*
*
* @return A Boolean value indicating whether the snapshot was created from an automatic snapshot.
*/
public Boolean isFromAutoSnapshot() {
return this.isFromAutoSnapshot;
}
/**
* 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 (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getSupportCode() != null)
sb.append("SupportCode: ").append(getSupportCode()).append(",");
if (getCreatedAt() != null)
sb.append("CreatedAt: ").append(getCreatedAt()).append(",");
if (getLocation() != null)
sb.append("Location: ").append(getLocation()).append(",");
if (getResourceType() != null)
sb.append("ResourceType: ").append(getResourceType()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getSizeInGb() != null)
sb.append("SizeInGb: ").append(getSizeInGb()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getProgress() != null)
sb.append("Progress: ").append(getProgress()).append(",");
if (getFromDiskName() != null)
sb.append("FromDiskName: ").append(getFromDiskName()).append(",");
if (getFromDiskArn() != null)
sb.append("FromDiskArn: ").append(getFromDiskArn()).append(",");
if (getFromInstanceName() != null)
sb.append("FromInstanceName: ").append(getFromInstanceName()).append(",");
if (getFromInstanceArn() != null)
sb.append("FromInstanceArn: ").append(getFromInstanceArn()).append(",");
if (getIsFromAutoSnapshot() != null)
sb.append("IsFromAutoSnapshot: ").append(getIsFromAutoSnapshot());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DiskSnapshot == false)
return false;
DiskSnapshot other = (DiskSnapshot) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getSupportCode() == null ^ this.getSupportCode() == null)
return false;
if (other.getSupportCode() != null && other.getSupportCode().equals(this.getSupportCode()) == false)
return false;
if (other.getCreatedAt() == null ^ this.getCreatedAt() == null)
return false;
if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == false)
return false;
if (other.getLocation() == null ^ this.getLocation() == null)
return false;
if (other.getLocation() != null && other.getLocation().equals(this.getLocation()) == false)
return false;
if (other.getResourceType() == null ^ this.getResourceType() == null)
return false;
if (other.getResourceType() != null && other.getResourceType().equals(this.getResourceType()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getSizeInGb() == null ^ this.getSizeInGb() == null)
return false;
if (other.getSizeInGb() != null && other.getSizeInGb().equals(this.getSizeInGb()) == false)
return false;
if (other.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == false)
return false;
if (other.getProgress() == null ^ this.getProgress() == null)
return false;
if (other.getProgress() != null && other.getProgress().equals(this.getProgress()) == false)
return false;
if (other.getFromDiskName() == null ^ this.getFromDiskName() == null)
return false;
if (other.getFromDiskName() != null && other.getFromDiskName().equals(this.getFromDiskName()) == false)
return false;
if (other.getFromDiskArn() == null ^ this.getFromDiskArn() == null)
return false;
if (other.getFromDiskArn() != null && other.getFromDiskArn().equals(this.getFromDiskArn()) == false)
return false;
if (other.getFromInstanceName() == null ^ this.getFromInstanceName() == null)
return false;
if (other.getFromInstanceName() != null && other.getFromInstanceName().equals(this.getFromInstanceName()) == false)
return false;
if (other.getFromInstanceArn() == null ^ this.getFromInstanceArn() == null)
return false;
if (other.getFromInstanceArn() != null && other.getFromInstanceArn().equals(this.getFromInstanceArn()) == false)
return false;
if (other.getIsFromAutoSnapshot() == null ^ this.getIsFromAutoSnapshot() == null)
return false;
if (other.getIsFromAutoSnapshot() != null && other.getIsFromAutoSnapshot().equals(this.getIsFromAutoSnapshot()) == 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 + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getSupportCode() == null) ? 0 : getSupportCode().hashCode());
hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode());
hashCode = prime * hashCode + ((getLocation() == null) ? 0 : getLocation().hashCode());
hashCode = prime * hashCode + ((getResourceType() == null) ? 0 : getResourceType().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getSizeInGb() == null) ? 0 : getSizeInGb().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getProgress() == null) ? 0 : getProgress().hashCode());
hashCode = prime * hashCode + ((getFromDiskName() == null) ? 0 : getFromDiskName().hashCode());
hashCode = prime * hashCode + ((getFromDiskArn() == null) ? 0 : getFromDiskArn().hashCode());
hashCode = prime * hashCode + ((getFromInstanceName() == null) ? 0 : getFromInstanceName().hashCode());
hashCode = prime * hashCode + ((getFromInstanceArn() == null) ? 0 : getFromInstanceArn().hashCode());
hashCode = prime * hashCode + ((getIsFromAutoSnapshot() == null) ? 0 : getIsFromAutoSnapshot().hashCode());
return hashCode;
}
@Override
public DiskSnapshot clone() {
try {
return (DiskSnapshot) 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.lightsail.model.transform.DiskSnapshotMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}