Class Disk
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Disk.Builder,
Disk>
Describes a block storage disk.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddOns()
An array of objects representing the add-ons enabled on the disk.final String
arn()
The Amazon Resource Name (ARN) of the disk.final String
The resources to which the disk is attached.final String
Deprecated.final AutoMountStatus
The status of automatically mounting a storage disk to a virtual computer.final String
The status of automatically mounting a storage disk to a virtual computer.static Disk.Builder
builder()
final Instant
The date when the disk was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
gbInUse()
Deprecated.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AddOns property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Integer
iops()
The input/output operations per second (IOPS) of the disk.final Boolean
A Boolean value indicating whether the disk is attached.final Boolean
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).final ResourceLocation
location()
The AWS Region and Availability Zone where the disk is located.final String
name()
The unique name of the disk.final String
path()
The disk path.final ResourceType
The Lightsail resource type (Disk
).final String
The Lightsail resource type (Disk
).static Class
<? extends Disk.Builder> final Integer
sizeInGb()
The size of the disk in GB.final DiskState
state()
Describes the status of the disk.final String
Describes the status of the disk.final String
The support code.tags()
The tag keys and optional values for the resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The unique name of the disk.
- Returns:
- The unique name of the disk.
-
arn
The Amazon Resource Name (ARN) of the disk.
- Returns:
- The Amazon Resource Name (ARN) of the disk.
-
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.
- Returns:
- 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.
-
createdAt
The date when the disk was created.
- Returns:
- The date when the disk was created.
-
location
The AWS Region and Availability Zone where the disk is located.
- Returns:
- The AWS Region and Availability Zone where the disk is located.
-
resourceType
The Lightsail resource type (
Disk
).If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The Lightsail resource type (
Disk
). - See Also:
-
resourceTypeAsString
The Lightsail resource type (
Disk
).If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The Lightsail resource type (
Disk
). - See Also:
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
-
hasAddOns
public final boolean hasAddOns()For responses, this returns true if the service returned a value for the AddOns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
addOns
An array of objects representing the add-ons enabled on the disk.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAddOns()
method.- Returns:
- An array of objects representing the add-ons enabled on the disk.
-
sizeInGb
The size of the disk in GB.
- Returns:
- The size of the disk in GB.
-
isSystemDisk
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
- Returns:
- A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
-
iops
The input/output operations per second (IOPS) of the disk.
- Returns:
- The input/output operations per second (IOPS) of the disk.
-
path
The disk path.
- Returns:
- The disk path.
-
state
Describes the status of the disk.
If the service returns an enum value that is not available in the current SDK version,
state
will returnDiskState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- Describes the status of the disk.
- See Also:
-
stateAsString
Describes the status of the disk.
If the service returns an enum value that is not available in the current SDK version,
state
will returnDiskState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- Describes the status of the disk.
- See Also:
-
attachedTo
The resources to which the disk is attached.
- Returns:
- The resources to which the disk is attached.
-
isAttached
A Boolean value indicating whether the disk is attached.
- Returns:
- A Boolean value indicating whether the disk is attached.
-
attachmentState
Deprecated.(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. UseisAttached
instead.- Returns:
- (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. UseisAttached
instead.
-
gbInUse
Deprecated.(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.
- Returns:
- (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.
-
autoMountStatus
The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
If the service returns an enum value that is not available in the current SDK version,
autoMountStatus
will returnAutoMountStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromautoMountStatusAsString()
.- Returns:
- The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
- See Also:
-
autoMountStatusAsString
The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
If the service returns an enum value that is not available in the current SDK version,
autoMountStatus
will returnAutoMountStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromautoMountStatusAsString()
.- Returns:
- The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Disk.Builder,
Disk> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
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. -
getValueForField
-
sdkFields
-