Class Volume
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Volume.Builder,
Volume>
Describes a volume.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<VolumeAttachment> Information about the volume attachments.final String
The Availability Zone for the volume.static Volume.Builder
builder()
final Instant
The time stamp when volume creation was initiated.final Boolean
Indicates whether the volume is encrypted.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
Indicates whether the volume was created using fast snapshot restore.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 Attachments 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 number of I/O operations per second (IOPS).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.final Boolean
Indicates whether Amazon EBS Multi-Attach is enabled.final String
The Amazon Resource Name (ARN) of the Outpost.static Class
<? extends Volume.Builder> final Integer
size()
The size of the volume, in GiBs.final String
The snapshot from which the volume was created, if applicable.final SSEType
sseType()
Reserved for future use.final String
Reserved for future use.final VolumeState
state()
The volume state.final String
The volume state.tags()
Any tags assigned to the volume.final Integer
The throughput that the volume supports, in MiB/s.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.final String
volumeId()
The ID of the volume.final VolumeType
The volume type.final String
The volume type.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The Availability Zone for the volume.
- Returns:
- The Availability Zone for the volume.
-
createTime
The time stamp when volume creation was initiated.
- Returns:
- The time stamp when volume creation was initiated.
-
encrypted
Indicates whether the volume is encrypted.
- Returns:
- Indicates whether the volume is encrypted.
-
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
The Amazon Resource Name (ARN) of the Outpost.
- Returns:
- The Amazon Resource Name (ARN) of the Outpost.
-
size
The size of the volume, in GiBs.
- Returns:
- The size of the volume, in GiBs.
-
snapshotId
The snapshot from which the volume was created, if applicable.
- Returns:
- The snapshot from which the volume was created, if applicable.
-
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:
-
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:
-
volumeId
The ID of the volume.
- Returns:
- The ID of the volume.
-
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
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
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:
-
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:
-
fastRestored
Indicates whether the volume was created using fast snapshot restore.
- Returns:
- Indicates whether the volume was created using fast snapshot restore.
-
multiAttachEnabled
Indicates whether Amazon EBS Multi-Attach is enabled.
- Returns:
- Indicates whether Amazon EBS Multi-Attach is enabled.
-
throughput
The throughput that the volume supports, in MiB/s.
- Returns:
- The throughput that the volume supports, in MiB/s.
-
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:
-
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:
-
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<Volume.Builder,
Volume> - 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
-