@Generated(value="software.amazon.awssdk:codegen") public class Disk extends Object implements StructuredPojo, ToCopyableBuilder<Disk.Builder,Disk>
Describes a system disk or an block storage disk.
Modifier and Type | Class and Description |
---|---|
static interface |
Disk.Builder |
Modifier and Type | Method and Description |
---|---|
String |
arn()
The Amazon Resource Name (ARN) of the disk.
|
String |
attachedTo()
The resources to which the disk is attached.
|
String |
attachmentState()
(Deprecated) The attachment state of the disk.
|
static Disk.Builder |
builder() |
Instant |
createdAt()
The date when the disk was created.
|
boolean |
equals(Object obj) |
Integer |
gbInUse()
(Deprecated) The number of GB in use by the disk.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Integer |
iops()
The input/output operations per second (IOPS) of the disk.
|
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).
|
ResourceLocation |
location()
The AWS Region and Availability Zone where the disk is located.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
name()
The unique name of the disk.
|
String |
path()
The disk path.
|
ResourceType |
resourceType()
The Lightsail resource type (e.g.,
Disk ). |
String |
resourceTypeString()
The Lightsail resource type (e.g.,
Disk ). |
static Class<? extends Disk.Builder> |
serializableBuilderClass() |
Integer |
sizeInGb()
The size of the disk in GB.
|
DiskState |
state()
Describes the status of the disk.
|
String |
stateString()
Describes the status of the disk.
|
String |
supportCode()
The support code.
|
Disk.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String name()
The unique name of the disk.
public String arn()
The Amazon Resource Name (ARN) of the disk.
public 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.
public Instant createdAt()
The date when the disk was created.
public ResourceLocation location()
The AWS Region and Availability Zone where the disk is located.
public ResourceType resourceType()
The Lightsail resource type (e.g., Disk
).
If the service returns an enum value that is not available in the current SDK version, resourceType
will
return ResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
resourceTypeString()
.
Disk
).ResourceType
public String resourceTypeString()
The Lightsail resource type (e.g., Disk
).
If the service returns an enum value that is not available in the current SDK version, resourceType
will
return ResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
resourceTypeString()
.
Disk
).ResourceType
public Integer sizeInGb()
The size of the disk in GB.
public Boolean isSystemDisk()
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
public Integer iops()
The input/output operations per second (IOPS) of the disk.
public String path()
The disk path.
public DiskState 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 return
DiskState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateString()
.
DiskState
public String stateString()
Describes the status of the disk.
If the service returns an enum value that is not available in the current SDK version, state
will return
DiskState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateString()
.
DiskState
public String attachedTo()
The resources to which the disk is attached.
public Boolean isAttached()
A Boolean value indicating whether the disk is attached.
public String attachmentState()
(Deprecated) The attachment state of the disk.
In releases prior to November 9, 2017, this parameter returned attached
for system disks in the API
response. It is now deprecated, but still included in the response. Use isAttached
instead.
In releases prior to November 9, 2017, this parameter returned attached
for system disks in
the API response. It is now deprecated, but still included in the response. Use isAttached
instead.
public Integer gbInUse()
(Deprecated) The number of GB in use by the disk.
In releases prior to November 9, 2017, this parameter was not included in the API response. It is now deprecated.
In releases prior to November 9, 2017, this parameter was not included in the API response. It is now deprecated.
public Disk.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Disk.Builder,Disk>
public static Disk.Builder builder()
public static Class<? extends Disk.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.