Class Volume
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.Volume
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Volume.Builder,Volume>
@Generated("software.amazon.awssdk:codegen") public final class Volume extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Volume.Builder,Volume>
Describes a volume.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Volume.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<VolumeAttachment>
attachments()
Information about the volume attachments.String
availabilityZone()
The Availability Zone for the volume.static Volume.Builder
builder()
Instant
createTime()
The time stamp when volume creation was initiated.Boolean
encrypted()
Indicates whether the volume is encrypted.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
Boolean
fastRestored()
Indicates whether the volume was created using fast snapshot restore.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAttachments()
For responses, this returns true if the service returned a value for the Attachments property.int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Integer
iops()
The number of I/O operations per second (IOPS).String
kmsKeyId()
The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.Boolean
multiAttachEnabled()
Indicates whether Amazon EBS Multi-Attach is enabled.String
outpostArn()
The Amazon Resource Name (ARN) of the Outpost.List<SdkField<?>>
sdkFields()
static Class<? extends Volume.Builder>
serializableBuilderClass()
Integer
size()
The size of the volume, in GiBs.String
snapshotId()
The snapshot from which the volume was created, if applicable.SSEType
sseType()
Reserved for future use.String
sseTypeAsString()
Reserved for future use.VolumeState
state()
The volume state.String
stateAsString()
The volume state.List<Tag>
tags()
Any tags assigned to the volume.Integer
throughput()
The throughput that the volume supports, in MiB/s.Volume.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
volumeId()
The ID of the volume.VolumeType
volumeType()
The volume type.String
volumeTypeAsString()
The volume type.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasAttachments
public final boolean hasAttachments()
For responses, this returns true if the service returned a value for the Attachments 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.
-
attachments
public final List<VolumeAttachment> attachments()
Information about the volume attachments.
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
hasAttachments()
method.- Returns:
- Information about the volume attachments.
-
availabilityZone
public final String availabilityZone()
The Availability Zone for the volume.
- Returns:
- The Availability Zone for the volume.
-
createTime
public final Instant createTime()
The time stamp when volume creation was initiated.
- Returns:
- The time stamp when volume creation was initiated.
-
encrypted
public final Boolean encrypted()
Indicates whether the volume is encrypted.
- Returns:
- Indicates whether the volume is encrypted.
-
kmsKeyId
public final String kmsKeyId()
The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
- Returns:
- The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
-
outpostArn
public final String outpostArn()
The Amazon Resource Name (ARN) of the Outpost.
- Returns:
- The Amazon Resource Name (ARN) of the Outpost.
-
size
public final Integer size()
The size of the volume, in GiBs.
- Returns:
- The size of the volume, in GiBs.
-
snapshotId
public final String snapshotId()
The snapshot from which the volume was created, if applicable.
- Returns:
- The snapshot from which the volume was created, if applicable.
-
state
public final VolumeState state()
The volume state.
If the service returns an enum value that is not available in the current SDK version,
state
will returnVolumeState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The volume state.
- See Also:
VolumeState
-
stateAsString
public final String stateAsString()
The volume state.
If the service returns an enum value that is not available in the current SDK version,
state
will returnVolumeState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The volume state.
- See Also:
VolumeState
-
volumeId
public final String volumeId()
The ID of the volume.
- Returns:
- The ID of the volume.
-
iops
public final Integer iops()
The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.- Returns:
- The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
-
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
public final List<Tag> tags()
Any tags assigned to the volume.
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:
- Any tags assigned to the volume.
-
volumeType
public final VolumeType volumeType()
The volume type.
If the service returns an enum value that is not available in the current SDK version,
volumeType
will returnVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeTypeAsString()
.- Returns:
- The volume type.
- See Also:
VolumeType
-
volumeTypeAsString
public final String volumeTypeAsString()
The volume type.
If the service returns an enum value that is not available in the current SDK version,
volumeType
will returnVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeTypeAsString()
.- Returns:
- The volume type.
- See Also:
VolumeType
-
fastRestored
public final Boolean fastRestored()
Indicates whether the volume was created using fast snapshot restore.
- Returns:
- Indicates whether the volume was created using fast snapshot restore.
-
multiAttachEnabled
public final Boolean multiAttachEnabled()
Indicates whether Amazon EBS Multi-Attach is enabled.
- Returns:
- Indicates whether Amazon EBS Multi-Attach is enabled.
-
throughput
public final Integer throughput()
The throughput that the volume supports, in MiB/s.
- Returns:
- The throughput that the volume supports, in MiB/s.
-
sseType
public final SSEType sseType()
Reserved for future use.
If the service returns an enum value that is not available in the current SDK version,
sseType
will returnSSEType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsseTypeAsString()
.- Returns:
- Reserved for future use.
- See Also:
SSEType
-
sseTypeAsString
public final String sseTypeAsString()
Reserved for future use.
If the service returns an enum value that is not available in the current SDK version,
sseType
will returnSSEType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsseTypeAsString()
.- Returns:
- Reserved for future use.
- See Also:
SSEType
-
toBuilder
public Volume.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Volume.Builder,Volume>
-
builder
public static Volume.Builder builder()
-
serializableBuilderClass
public static Class<? extends Volume.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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.
-
-