@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Disk extends Object implements Serializable, Cloneable, StructuredPojo
Describes a block storage disk.
Constructor and Description |
---|
Disk() |
Modifier and Type | Method and Description |
---|---|
Disk |
clone() |
boolean |
equals(Object obj) |
List<AddOn> |
getAddOns()
An array of objects representing the add-ons enabled on the disk.
|
String |
getArn()
The Amazon Resource Name (ARN) of the disk.
|
String |
getAttachedTo()
The resources to which the disk is attached.
|
String |
getAttachmentState()
Deprecated.
|
String |
getAutoMountStatus()
The status of automatically mounting a storage disk to a virtual computer.
|
Date |
getCreatedAt()
The date when the disk was created.
|
Integer |
getGbInUse()
Deprecated.
|
Integer |
getIops()
The input/output operations per second (IOPS) of the disk.
|
Boolean |
getIsAttached()
A Boolean value indicating whether the disk is attached.
|
Boolean |
getIsSystemDisk()
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
|
ResourceLocation |
getLocation()
The AWS Region and Availability Zone where the disk is located.
|
String |
getName()
The unique name of the disk.
|
String |
getPath()
The disk path.
|
String |
getResourceType()
The Lightsail resource type (
Disk ). |
Integer |
getSizeInGb()
The size of the disk in GB.
|
String |
getState()
Describes the status of the disk.
|
String |
getSupportCode()
The support code.
|
List<Tag> |
getTags()
The tag keys and optional values for the resource.
|
int |
hashCode() |
Boolean |
isAttached()
A Boolean value indicating whether the disk is attached.
|
Boolean |
isSystemDisk()
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAddOns(Collection<AddOn> addOns)
An array of objects representing the add-ons enabled on the disk.
|
void |
setArn(String arn)
The Amazon Resource Name (ARN) of the disk.
|
void |
setAttachedTo(String attachedTo)
The resources to which the disk is attached.
|
void |
setAttachmentState(String attachmentState)
Deprecated.
|
void |
setAutoMountStatus(AutoMountStatus autoMountStatus)
The status of automatically mounting a storage disk to a virtual computer.
|
void |
setAutoMountStatus(String autoMountStatus)
The status of automatically mounting a storage disk to a virtual computer.
|
void |
setCreatedAt(Date createdAt)
The date when the disk was created.
|
void |
setGbInUse(Integer gbInUse)
Deprecated.
|
void |
setIops(Integer iops)
The input/output operations per second (IOPS) of the disk.
|
void |
setIsAttached(Boolean isAttached)
A Boolean value indicating whether the disk is attached.
|
void |
setIsSystemDisk(Boolean isSystemDisk)
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
|
void |
setLocation(ResourceLocation location)
The AWS Region and Availability Zone where the disk is located.
|
void |
setName(String name)
The unique name of the disk.
|
void |
setPath(String path)
The disk path.
|
void |
setResourceType(ResourceType resourceType)
The Lightsail resource type (
Disk ). |
void |
setResourceType(String resourceType)
The Lightsail resource type (
Disk ). |
void |
setSizeInGb(Integer sizeInGb)
The size of the disk in GB.
|
void |
setState(DiskState state)
Describes the status of the disk.
|
void |
setState(String state)
Describes the status of the disk.
|
void |
setSupportCode(String supportCode)
The support code.
|
void |
setTags(Collection<Tag> tags)
The tag keys and optional values for the resource.
|
String |
toString()
Returns a string representation of this object.
|
Disk |
withAddOns(AddOn... addOns)
An array of objects representing the add-ons enabled on the disk.
|
Disk |
withAddOns(Collection<AddOn> addOns)
An array of objects representing the add-ons enabled on the disk.
|
Disk |
withArn(String arn)
The Amazon Resource Name (ARN) of the disk.
|
Disk |
withAttachedTo(String attachedTo)
The resources to which the disk is attached.
|
Disk |
withAttachmentState(String attachmentState)
Deprecated.
|
Disk |
withAutoMountStatus(AutoMountStatus autoMountStatus)
The status of automatically mounting a storage disk to a virtual computer.
|
Disk |
withAutoMountStatus(String autoMountStatus)
The status of automatically mounting a storage disk to a virtual computer.
|
Disk |
withCreatedAt(Date createdAt)
The date when the disk was created.
|
Disk |
withGbInUse(Integer gbInUse)
Deprecated.
|
Disk |
withIops(Integer iops)
The input/output operations per second (IOPS) of the disk.
|
Disk |
withIsAttached(Boolean isAttached)
A Boolean value indicating whether the disk is attached.
|
Disk |
withIsSystemDisk(Boolean isSystemDisk)
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
|
Disk |
withLocation(ResourceLocation location)
The AWS Region and Availability Zone where the disk is located.
|
Disk |
withName(String name)
The unique name of the disk.
|
Disk |
withPath(String path)
The disk path.
|
Disk |
withResourceType(ResourceType resourceType)
The Lightsail resource type (
Disk ). |
Disk |
withResourceType(String resourceType)
The Lightsail resource type (
Disk ). |
Disk |
withSizeInGb(Integer sizeInGb)
The size of the disk in GB.
|
Disk |
withState(DiskState state)
Describes the status of the disk.
|
Disk |
withState(String state)
Describes the status of the disk.
|
Disk |
withSupportCode(String supportCode)
The support code.
|
Disk |
withTags(Collection<Tag> tags)
The tag keys and optional values for the resource.
|
Disk |
withTags(Tag... tags)
The tag keys and optional values for the resource.
|
public void setName(String name)
The unique name of the disk.
name
- The unique name of the disk.public String getName()
The unique name of the disk.
public Disk withName(String name)
The unique name of the disk.
name
- The unique name of the disk.public void setArn(String arn)
The Amazon Resource Name (ARN) of the disk.
arn
- The Amazon Resource Name (ARN) of the disk.public String getArn()
The Amazon Resource Name (ARN) of the disk.
public Disk withArn(String arn)
The Amazon Resource Name (ARN) of the disk.
arn
- The Amazon Resource Name (ARN) of the disk.public void setSupportCode(String 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.
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 String getSupportCode()
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 Disk withSupportCode(String 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.
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 setCreatedAt(Date createdAt)
The date when the disk was created.
createdAt
- The date when the disk was created.public Date getCreatedAt()
The date when the disk was created.
public Disk withCreatedAt(Date createdAt)
The date when the disk was created.
createdAt
- The date when the disk was created.public void setLocation(ResourceLocation location)
The AWS Region and Availability Zone where the disk is located.
location
- The AWS Region and Availability Zone where the disk is located.public ResourceLocation getLocation()
The AWS Region and Availability Zone where the disk is located.
public Disk withLocation(ResourceLocation location)
The AWS Region and Availability Zone where the disk is located.
location
- The AWS Region and Availability Zone where the disk is located.public void setResourceType(String resourceType)
The Lightsail resource type (Disk
).
resourceType
- The Lightsail resource type (Disk
).ResourceType
public String getResourceType()
The Lightsail resource type (Disk
).
Disk
).ResourceType
public Disk withResourceType(String resourceType)
The Lightsail resource type (Disk
).
resourceType
- The Lightsail resource type (Disk
).ResourceType
public void setResourceType(ResourceType resourceType)
The Lightsail resource type (Disk
).
resourceType
- The Lightsail resource type (Disk
).ResourceType
public Disk withResourceType(ResourceType resourceType)
The Lightsail resource type (Disk
).
resourceType
- The Lightsail resource type (Disk
).ResourceType
public List<Tag> getTags()
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(Collection<Tag> tags)
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
tags
- The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
Amazon Lightsail
Developer Guide.public Disk withTags(Tag... 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
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
Amazon Lightsail
Developer Guide.public Disk withTags(Collection<Tag> tags)
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
tags
- The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
Amazon Lightsail
Developer Guide.public List<AddOn> getAddOns()
An array of objects representing the add-ons enabled on the disk.
public void setAddOns(Collection<AddOn> addOns)
An array of objects representing the add-ons enabled on the disk.
addOns
- An array of objects representing the add-ons enabled on the disk.public Disk withAddOns(AddOn... addOns)
An array of objects representing the add-ons enabled on the disk.
NOTE: This method appends the values to the existing list (if any). Use
setAddOns(java.util.Collection)
or withAddOns(java.util.Collection)
if you want to override the
existing values.
addOns
- An array of objects representing the add-ons enabled on the disk.public Disk withAddOns(Collection<AddOn> addOns)
An array of objects representing the add-ons enabled on the disk.
addOns
- An array of objects representing the add-ons enabled on the disk.public void setSizeInGb(Integer sizeInGb)
The size of the disk in GB.
sizeInGb
- The size of the disk in GB.public Integer getSizeInGb()
The size of the disk in GB.
public Disk withSizeInGb(Integer sizeInGb)
The size of the disk in GB.
sizeInGb
- The size of the disk in GB.public void setIsSystemDisk(Boolean isSystemDisk)
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
isSystemDisk
- A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).public Boolean getIsSystemDisk()
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
public Disk withIsSystemDisk(Boolean isSystemDisk)
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
isSystemDisk
- A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).public Boolean isSystemDisk()
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
public void setIops(Integer iops)
The input/output operations per second (IOPS) of the disk.
iops
- The input/output operations per second (IOPS) of the disk.public Integer getIops()
The input/output operations per second (IOPS) of the disk.
public Disk withIops(Integer iops)
The input/output operations per second (IOPS) of the disk.
iops
- The input/output operations per second (IOPS) of the disk.public void setPath(String path)
The disk path.
path
- The disk path.public String getPath()
The disk path.
public Disk withPath(String path)
The disk path.
path
- The disk path.public void setState(String state)
Describes the status of the disk.
state
- Describes the status of the disk.DiskState
public String getState()
Describes the status of the disk.
DiskState
public Disk withState(String state)
Describes the status of the disk.
state
- Describes the status of the disk.DiskState
public void setState(DiskState state)
Describes the status of the disk.
state
- Describes the status of the disk.DiskState
public Disk withState(DiskState state)
Describes the status of the disk.
state
- Describes the status of the disk.DiskState
public void setAttachedTo(String attachedTo)
The resources to which the disk is attached.
attachedTo
- The resources to which the disk is attached.public String getAttachedTo()
The resources to which the disk is attached.
public Disk withAttachedTo(String attachedTo)
The resources to which the disk is attached.
attachedTo
- The resources to which the disk is attached.public void setIsAttached(Boolean isAttached)
A Boolean value indicating whether the disk is attached.
isAttached
- A Boolean value indicating whether the disk is attached.public Boolean getIsAttached()
A Boolean value indicating whether the disk is attached.
public Disk withIsAttached(Boolean isAttached)
A Boolean value indicating whether the disk is attached.
isAttached
- A Boolean value indicating whether the disk is attached.public Boolean isAttached()
A Boolean value indicating whether the disk is attached.
@Deprecated public void setAttachmentState(String attachmentState)
(Discontinued) The attachment state of the disk.
In releases prior to November 14, 2017, this parameter returned attached
for system disks in the API
response. It is now discontinued, but still included in the response. Use isAttached
instead.
attachmentState
- (Discontinued) The attachment state of the disk.
In releases prior to November 14, 2017, this parameter returned attached
for system disks in
the API response. It is now discontinued, but still included in the response. Use isAttached
instead.
@Deprecated public String getAttachmentState()
(Discontinued) The attachment state of the disk.
In releases prior to November 14, 2017, this parameter returned attached
for system disks in the API
response. It is now discontinued, but still included in the response. Use isAttached
instead.
In releases prior to November 14, 2017, this parameter returned attached
for system disks in
the API response. It is now discontinued, but still included in the response. Use isAttached
instead.
@Deprecated public Disk withAttachmentState(String attachmentState)
(Discontinued) The attachment state of the disk.
In releases prior to November 14, 2017, this parameter returned attached
for system disks in the API
response. It is now discontinued, but still included in the response. Use isAttached
instead.
attachmentState
- (Discontinued) The attachment state of the disk.
In releases prior to November 14, 2017, this parameter returned attached
for system disks in
the API response. It is now discontinued, but still included in the response. Use isAttached
instead.
@Deprecated public void setGbInUse(Integer gbInUse)
(Discontinued) The number of GB in use by the disk.
In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.
gbInUse
- (Discontinued) The number of GB in use by the disk. In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.
@Deprecated public Integer getGbInUse()
(Discontinued) The number of GB in use by the disk.
In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.
In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.
@Deprecated public Disk withGbInUse(Integer gbInUse)
(Discontinued) The number of GB in use by the disk.
In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.
gbInUse
- (Discontinued) The number of GB in use by the disk. In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.
public void setAutoMountStatus(String autoMountStatus)
The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
autoMountStatus
- The status of automatically mounting a storage disk to a virtual computer. This parameter only applies to Lightsail for Research resources.
AutoMountStatus
public String getAutoMountStatus()
The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
This parameter only applies to Lightsail for Research resources.
AutoMountStatus
public Disk withAutoMountStatus(String autoMountStatus)
The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
autoMountStatus
- The status of automatically mounting a storage disk to a virtual computer. This parameter only applies to Lightsail for Research resources.
AutoMountStatus
public void setAutoMountStatus(AutoMountStatus autoMountStatus)
The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
autoMountStatus
- The status of automatically mounting a storage disk to a virtual computer. This parameter only applies to Lightsail for Research resources.
AutoMountStatus
public Disk withAutoMountStatus(AutoMountStatus autoMountStatus)
The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
autoMountStatus
- The status of automatically mounting a storage disk to a virtual computer. This parameter only applies to Lightsail for Research resources.
AutoMountStatus
public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.