
com.amazonaws.services.opsworks.model.Volume Maven / Gradle / Ivy
/*
* Copyright 2013-2018 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.opsworks.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes an instance's Amazon EBS volume.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Volume implements Serializable, Cloneable, StructuredPojo {
/**
*
* The volume ID.
*
*/
private String volumeId;
/**
*
* The Amazon EC2 volume ID.
*
*/
private String ec2VolumeId;
/**
*
* The volume name.
*
*/
private String name;
/**
*
* The RAID array ID.
*
*/
private String raidArrayId;
/**
*
* The instance ID.
*
*/
private String instanceId;
/**
*
* The value returned by DescribeVolumes.
*
*/
private String status;
/**
*
* The volume size.
*
*/
private Integer size;
/**
*
* The device name.
*
*/
private String device;
/**
*
* The volume mount point. For example, "/mnt/disk1".
*
*/
private String mountPoint;
/**
*
* The AWS region. For more information about AWS regions, see Regions and Endpoints.
*
*/
private String region;
/**
*
* The volume Availability Zone. For more information, see Regions and Endpoints.
*
*/
private String availabilityZone;
/**
*
* The volume type. For more information, see Amazon EBS Volume Types.
*
*
* -
*
* standard
- Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024
* GiB.
*
*
* -
*
* io1
- Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of
* 16384 GiB.
*
*
* -
*
* gp2
- General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum
* size of 16384 GiB.
*
*
* -
*
* st1
- Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a
* minimum size of 500 GiB and a maximum size of 16384 GiB.
*
*
* -
*
* sc1
- Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384
* GiB.
*
*
*
*/
private String volumeType;
/**
*
* For PIOPS volumes, the IOPS per disk.
*
*/
private Integer iops;
/**
*
* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
*
*/
private Boolean encrypted;
/**
*
* The volume ID.
*
*
* @param volumeId
* The volume ID.
*/
public void setVolumeId(String volumeId) {
this.volumeId = volumeId;
}
/**
*
* The volume ID.
*
*
* @return The volume ID.
*/
public String getVolumeId() {
return this.volumeId;
}
/**
*
* The volume ID.
*
*
* @param volumeId
* The volume ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withVolumeId(String volumeId) {
setVolumeId(volumeId);
return this;
}
/**
*
* The Amazon EC2 volume ID.
*
*
* @param ec2VolumeId
* The Amazon EC2 volume ID.
*/
public void setEc2VolumeId(String ec2VolumeId) {
this.ec2VolumeId = ec2VolumeId;
}
/**
*
* The Amazon EC2 volume ID.
*
*
* @return The Amazon EC2 volume ID.
*/
public String getEc2VolumeId() {
return this.ec2VolumeId;
}
/**
*
* The Amazon EC2 volume ID.
*
*
* @param ec2VolumeId
* The Amazon EC2 volume ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withEc2VolumeId(String ec2VolumeId) {
setEc2VolumeId(ec2VolumeId);
return this;
}
/**
*
* The volume name.
*
*
* @param name
* The volume name.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The volume name.
*
*
* @return The volume name.
*/
public String getName() {
return this.name;
}
/**
*
* The volume name.
*
*
* @param name
* The volume name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withName(String name) {
setName(name);
return this;
}
/**
*
* The RAID array ID.
*
*
* @param raidArrayId
* The RAID array ID.
*/
public void setRaidArrayId(String raidArrayId) {
this.raidArrayId = raidArrayId;
}
/**
*
* The RAID array ID.
*
*
* @return The RAID array ID.
*/
public String getRaidArrayId() {
return this.raidArrayId;
}
/**
*
* The RAID array ID.
*
*
* @param raidArrayId
* The RAID array ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withRaidArrayId(String raidArrayId) {
setRaidArrayId(raidArrayId);
return this;
}
/**
*
* The instance ID.
*
*
* @param instanceId
* The instance ID.
*/
public void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
/**
*
* The instance ID.
*
*
* @return The instance ID.
*/
public String getInstanceId() {
return this.instanceId;
}
/**
*
* The instance ID.
*
*
* @param instanceId
* The instance ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withInstanceId(String instanceId) {
setInstanceId(instanceId);
return this;
}
/**
*
* The value returned by DescribeVolumes.
*
*
* @param status
* The value returned by DescribeVolumes.
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The value returned by DescribeVolumes.
*
*
* @return The value returned by DescribeVolumes.
*/
public String getStatus() {
return this.status;
}
/**
*
* The value returned by DescribeVolumes.
*
*
* @param status
* The value returned by DescribeVolumes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The volume size.
*
*
* @param size
* The volume size.
*/
public void setSize(Integer size) {
this.size = size;
}
/**
*
* The volume size.
*
*
* @return The volume size.
*/
public Integer getSize() {
return this.size;
}
/**
*
* The volume size.
*
*
* @param size
* The volume size.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withSize(Integer size) {
setSize(size);
return this;
}
/**
*
* The device name.
*
*
* @param device
* The device name.
*/
public void setDevice(String device) {
this.device = device;
}
/**
*
* The device name.
*
*
* @return The device name.
*/
public String getDevice() {
return this.device;
}
/**
*
* The device name.
*
*
* @param device
* The device name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withDevice(String device) {
setDevice(device);
return this;
}
/**
*
* The volume mount point. For example, "/mnt/disk1".
*
*
* @param mountPoint
* The volume mount point. For example, "/mnt/disk1".
*/
public void setMountPoint(String mountPoint) {
this.mountPoint = mountPoint;
}
/**
*
* The volume mount point. For example, "/mnt/disk1".
*
*
* @return The volume mount point. For example, "/mnt/disk1".
*/
public String getMountPoint() {
return this.mountPoint;
}
/**
*
* The volume mount point. For example, "/mnt/disk1".
*
*
* @param mountPoint
* The volume mount point. For example, "/mnt/disk1".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withMountPoint(String mountPoint) {
setMountPoint(mountPoint);
return this;
}
/**
*
* The AWS region. For more information about AWS regions, see Regions and Endpoints.
*
*
* @param region
* The AWS region. For more information about AWS regions, see Regions and Endpoints.
*/
public void setRegion(String region) {
this.region = region;
}
/**
*
* The AWS region. For more information about AWS regions, see Regions and Endpoints.
*
*
* @return The AWS region. For more information about AWS regions, see Regions and Endpoints.
*/
public String getRegion() {
return this.region;
}
/**
*
* The AWS region. For more information about AWS regions, see Regions and Endpoints.
*
*
* @param region
* The AWS region. For more information about AWS regions, see Regions and Endpoints.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withRegion(String region) {
setRegion(region);
return this;
}
/**
*
* The volume Availability Zone. For more information, see Regions and Endpoints.
*
*
* @param availabilityZone
* The volume Availability Zone. For more information, see Regions and Endpoints.
*/
public void setAvailabilityZone(String availabilityZone) {
this.availabilityZone = availabilityZone;
}
/**
*
* The volume Availability Zone. For more information, see Regions and Endpoints.
*
*
* @return The volume Availability Zone. For more information, see Regions and Endpoints.
*/
public String getAvailabilityZone() {
return this.availabilityZone;
}
/**
*
* The volume Availability Zone. For more information, see Regions and Endpoints.
*
*
* @param availabilityZone
* The volume Availability Zone. For more information, see Regions and Endpoints.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withAvailabilityZone(String availabilityZone) {
setAvailabilityZone(availabilityZone);
return this;
}
/**
*
* The volume type. For more information, see Amazon EBS Volume Types.
*
*
* -
*
* standard
- Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024
* GiB.
*
*
* -
*
* io1
- Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of
* 16384 GiB.
*
*
* -
*
* gp2
- General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum
* size of 16384 GiB.
*
*
* -
*
* st1
- Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a
* minimum size of 500 GiB and a maximum size of 16384 GiB.
*
*
* -
*
* sc1
- Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384
* GiB.
*
*
*
*
* @param volumeType
* The volume type. For more information, see Amazon EBS Volume
* Types.
*
* -
*
* standard
- Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of
* 1024 GiB.
*
*
* -
*
* io1
- Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum
* size of 16384 GiB.
*
*
* -
*
* gp2
- General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a
* maximum size of 16384 GiB.
*
*
* -
*
* st1
- Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have
* a minimum size of 500 GiB and a maximum size of 16384 GiB.
*
*
* -
*
* sc1
- Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of
* 16384 GiB.
*
*
*/
public void setVolumeType(String volumeType) {
this.volumeType = volumeType;
}
/**
*
* The volume type. For more information, see Amazon EBS Volume Types.
*
*
* -
*
* standard
- Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024
* GiB.
*
*
* -
*
* io1
- Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of
* 16384 GiB.
*
*
* -
*
* gp2
- General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum
* size of 16384 GiB.
*
*
* -
*
* st1
- Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a
* minimum size of 500 GiB and a maximum size of 16384 GiB.
*
*
* -
*
* sc1
- Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384
* GiB.
*
*
*
*
* @return The volume type. For more information, see Amazon EBS Volume
* Types.
*
* -
*
* standard
- Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size
* of 1024 GiB.
*
*
* -
*
* io1
- Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum
* size of 16384 GiB.
*
*
* -
*
* gp2
- General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a
* maximum size of 16384 GiB.
*
*
* -
*
* st1
- Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have
* a minimum size of 500 GiB and a maximum size of 16384 GiB.
*
*
* -
*
* sc1
- Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of
* 16384 GiB.
*
*
*/
public String getVolumeType() {
return this.volumeType;
}
/**
*
* The volume type. For more information, see Amazon EBS Volume Types.
*
*
* -
*
* standard
- Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024
* GiB.
*
*
* -
*
* io1
- Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of
* 16384 GiB.
*
*
* -
*
* gp2
- General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum
* size of 16384 GiB.
*
*
* -
*
* st1
- Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a
* minimum size of 500 GiB and a maximum size of 16384 GiB.
*
*
* -
*
* sc1
- Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384
* GiB.
*
*
*
*
* @param volumeType
* The volume type. For more information, see Amazon EBS Volume
* Types.
*
* -
*
* standard
- Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of
* 1024 GiB.
*
*
* -
*
* io1
- Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum
* size of 16384 GiB.
*
*
* -
*
* gp2
- General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a
* maximum size of 16384 GiB.
*
*
* -
*
* st1
- Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have
* a minimum size of 500 GiB and a maximum size of 16384 GiB.
*
*
* -
*
* sc1
- Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of
* 16384 GiB.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withVolumeType(String volumeType) {
setVolumeType(volumeType);
return this;
}
/**
*
* For PIOPS volumes, the IOPS per disk.
*
*
* @param iops
* For PIOPS volumes, the IOPS per disk.
*/
public void setIops(Integer iops) {
this.iops = iops;
}
/**
*
* For PIOPS volumes, the IOPS per disk.
*
*
* @return For PIOPS volumes, the IOPS per disk.
*/
public Integer getIops() {
return this.iops;
}
/**
*
* For PIOPS volumes, the IOPS per disk.
*
*
* @param iops
* For PIOPS volumes, the IOPS per disk.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withIops(Integer iops) {
setIops(iops);
return this;
}
/**
*
* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
*
*
* @param encrypted
* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
*/
public void setEncrypted(Boolean encrypted) {
this.encrypted = encrypted;
}
/**
*
* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
*
*
* @return Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
*/
public Boolean getEncrypted() {
return this.encrypted;
}
/**
*
* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
*
*
* @param encrypted
* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Volume withEncrypted(Boolean encrypted) {
setEncrypted(encrypted);
return this;
}
/**
*
* Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
*
*
* @return Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
*/
public Boolean isEncrypted() {
return this.encrypted;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getVolumeId() != null)
sb.append("VolumeId: ").append(getVolumeId()).append(",");
if (getEc2VolumeId() != null)
sb.append("Ec2VolumeId: ").append(getEc2VolumeId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getRaidArrayId() != null)
sb.append("RaidArrayId: ").append(getRaidArrayId()).append(",");
if (getInstanceId() != null)
sb.append("InstanceId: ").append(getInstanceId()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getSize() != null)
sb.append("Size: ").append(getSize()).append(",");
if (getDevice() != null)
sb.append("Device: ").append(getDevice()).append(",");
if (getMountPoint() != null)
sb.append("MountPoint: ").append(getMountPoint()).append(",");
if (getRegion() != null)
sb.append("Region: ").append(getRegion()).append(",");
if (getAvailabilityZone() != null)
sb.append("AvailabilityZone: ").append(getAvailabilityZone()).append(",");
if (getVolumeType() != null)
sb.append("VolumeType: ").append(getVolumeType()).append(",");
if (getIops() != null)
sb.append("Iops: ").append(getIops()).append(",");
if (getEncrypted() != null)
sb.append("Encrypted: ").append(getEncrypted());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Volume == false)
return false;
Volume other = (Volume) obj;
if (other.getVolumeId() == null ^ this.getVolumeId() == null)
return false;
if (other.getVolumeId() != null && other.getVolumeId().equals(this.getVolumeId()) == false)
return false;
if (other.getEc2VolumeId() == null ^ this.getEc2VolumeId() == null)
return false;
if (other.getEc2VolumeId() != null && other.getEc2VolumeId().equals(this.getEc2VolumeId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getRaidArrayId() == null ^ this.getRaidArrayId() == null)
return false;
if (other.getRaidArrayId() != null && other.getRaidArrayId().equals(this.getRaidArrayId()) == false)
return false;
if (other.getInstanceId() == null ^ this.getInstanceId() == null)
return false;
if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getSize() == null ^ this.getSize() == null)
return false;
if (other.getSize() != null && other.getSize().equals(this.getSize()) == false)
return false;
if (other.getDevice() == null ^ this.getDevice() == null)
return false;
if (other.getDevice() != null && other.getDevice().equals(this.getDevice()) == false)
return false;
if (other.getMountPoint() == null ^ this.getMountPoint() == null)
return false;
if (other.getMountPoint() != null && other.getMountPoint().equals(this.getMountPoint()) == false)
return false;
if (other.getRegion() == null ^ this.getRegion() == null)
return false;
if (other.getRegion() != null && other.getRegion().equals(this.getRegion()) == false)
return false;
if (other.getAvailabilityZone() == null ^ this.getAvailabilityZone() == null)
return false;
if (other.getAvailabilityZone() != null && other.getAvailabilityZone().equals(this.getAvailabilityZone()) == false)
return false;
if (other.getVolumeType() == null ^ this.getVolumeType() == null)
return false;
if (other.getVolumeType() != null && other.getVolumeType().equals(this.getVolumeType()) == false)
return false;
if (other.getIops() == null ^ this.getIops() == null)
return false;
if (other.getIops() != null && other.getIops().equals(this.getIops()) == false)
return false;
if (other.getEncrypted() == null ^ this.getEncrypted() == null)
return false;
if (other.getEncrypted() != null && other.getEncrypted().equals(this.getEncrypted()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVolumeId() == null) ? 0 : getVolumeId().hashCode());
hashCode = prime * hashCode + ((getEc2VolumeId() == null) ? 0 : getEc2VolumeId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getRaidArrayId() == null) ? 0 : getRaidArrayId().hashCode());
hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getSize() == null) ? 0 : getSize().hashCode());
hashCode = prime * hashCode + ((getDevice() == null) ? 0 : getDevice().hashCode());
hashCode = prime * hashCode + ((getMountPoint() == null) ? 0 : getMountPoint().hashCode());
hashCode = prime * hashCode + ((getRegion() == null) ? 0 : getRegion().hashCode());
hashCode = prime * hashCode + ((getAvailabilityZone() == null) ? 0 : getAvailabilityZone().hashCode());
hashCode = prime * hashCode + ((getVolumeType() == null) ? 0 : getVolumeType().hashCode());
hashCode = prime * hashCode + ((getIops() == null) ? 0 : getIops().hashCode());
hashCode = prime * hashCode + ((getEncrypted() == null) ? 0 : getEncrypted().hashCode());
return hashCode;
}
@Override
public Volume clone() {
try {
return (Volume) 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.opsworks.model.transform.VolumeMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}