Package software.amazon.awssdk.services.ec2.model

Class VolumeModification

java.lang.Object
software.amazon.awssdk.services.ec2.model.VolumeModification
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VolumeModification.Builder,VolumeModification>
@Generated("software.amazon.awssdk:codegen") public final class VolumeModification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VolumeModification.Builder,VolumeModification>

Describes the modification status of an EBS volume.

If the volume has never been modified, some element values will be null.

See Also:

  • Method Details

    • volumeId

      public final String volumeId()

      The ID of the volume.

      Returns:
      The ID of the volume.

    • modificationState

      public final VolumeModificationState modificationState()

      The current modification state. The modification state is null for unmodified volumes.

      If the service returns an enum value that is not available in the current SDK version, modificationState will return VolumeModificationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modificationStateAsString().

      Returns:
      The current modification state. The modification state is null for unmodified volumes.
      See Also:

    • modificationStateAsString

      public final String modificationStateAsString()

      The current modification state. The modification state is null for unmodified volumes.

      If the service returns an enum value that is not available in the current SDK version, modificationState will return VolumeModificationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modificationStateAsString().

      Returns:
      The current modification state. The modification state is null for unmodified volumes.
      See Also:

    • statusMessage

      public final String statusMessage()

      A status message about the modification progress or failure.

      Returns:
      A status message about the modification progress or failure.

    • targetSize

      public final Integer targetSize()

      The target size of the volume, in GiB.

      Returns:
      The target size of the volume, in GiB.

    • targetIops

      public final Integer targetIops()

      The target IOPS rate of the volume.

      Returns:
      The target IOPS rate of the volume.

    • targetVolumeType

      public final VolumeType targetVolumeType()

      The target EBS volume type of the volume.

      If the service returns an enum value that is not available in the current SDK version, targetVolumeType will return VolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetVolumeTypeAsString().

      Returns:
      The target EBS volume type of the volume.
      See Also:

    • targetVolumeTypeAsString

      public final String targetVolumeTypeAsString()

      The target EBS volume type of the volume.

      If the service returns an enum value that is not available in the current SDK version, targetVolumeType will return VolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetVolumeTypeAsString().

      Returns:
      The target EBS volume type of the volume.
      See Also:

    • targetThroughput

      public final Integer targetThroughput()

      The target throughput of the volume, in MiB/s.

      Returns:
      The target throughput of the volume, in MiB/s.

    • targetMultiAttachEnabled

      public final Boolean targetMultiAttachEnabled()

      The target setting for Amazon EBS Multi-Attach.

      Returns:
      The target setting for Amazon EBS Multi-Attach.

    • originalSize

      public final Integer originalSize()

      The original size of the volume, in GiB.

      Returns:
      The original size of the volume, in GiB.

    • originalIops

      public final Integer originalIops()

      The original IOPS rate of the volume.

      Returns:
      The original IOPS rate of the volume.

    • originalVolumeType

      public final VolumeType originalVolumeType()

      The original EBS volume type of the volume.

      If the service returns an enum value that is not available in the current SDK version, originalVolumeType will return VolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originalVolumeTypeAsString().

      Returns:
      The original EBS volume type of the volume.
      See Also:

    • originalVolumeTypeAsString

      public final String originalVolumeTypeAsString()

      The original EBS volume type of the volume.

      If the service returns an enum value that is not available in the current SDK version, originalVolumeType will return VolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originalVolumeTypeAsString().

      Returns:
      The original EBS volume type of the volume.
      See Also:

    • originalThroughput

      public final Integer originalThroughput()

      The original throughput of the volume, in MiB/s.

      Returns:
      The original throughput of the volume, in MiB/s.

    • originalMultiAttachEnabled

      public final Boolean originalMultiAttachEnabled()

      The original setting for Amazon EBS Multi-Attach.

      Returns:
      The original setting for Amazon EBS Multi-Attach.

    • progress

      public final Long progress()

      The modification progress, from 0 to 100 percent complete.

      Returns:
      The modification progress, from 0 to 100 percent complete.

    • startTime

      public final Instant startTime()

      The modification start time.

      Returns:
      The modification start time.

    • endTime

      public final Instant endTime()

      The modification completion or failure time.

      Returns:
      The modification completion or failure time.

    • toBuilder

      public VolumeModification.Builder 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 interface ToCopyableBuilder<VolumeModification.Builder,VolumeModification>
      Returns:
      a builder for type T

    • builder

      public static VolumeModification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends VolumeModification.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.