Package software.amazon.awssdk.services.storagegateway.model

Class CachediSCSIVolume

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

Describes an iSCSI cached volume.

See Also:

  • Method Details

    • volumeARN

      public final String volumeARN()

      The Amazon Resource Name (ARN) of the storage volume.

      Returns:
      The Amazon Resource Name (ARN) of the storage volume.

    • volumeId

      public final String volumeId()

      The unique identifier of the volume, e.g., vol-AE4B946D.

      Returns:
      The unique identifier of the volume, e.g., vol-AE4B946D.

    • volumeType

      public final String volumeType()

      One of the VolumeType enumeration values that describes the type of the volume.

      Returns:
      One of the VolumeType enumeration values that describes the type of the volume.

    • volumeStatus

      public final String volumeStatus()

      One of the VolumeStatus values that indicates the state of the storage volume.

      Returns:
      One of the VolumeStatus values that indicates the state of the storage volume.

    • volumeAttachmentStatus

      public final String volumeAttachmentStatus()

      A value that indicates whether a storage volume is attached to or detached from a gateway. For more information, see Moving your volumes to a different gateway.

      Returns:
      A value that indicates whether a storage volume is attached to or detached from a gateway. For more information, see Moving your volumes to a different gateway.

    • volumeSizeInBytes

      public final Long volumeSizeInBytes()

      The size, in bytes, of the volume capacity.

      Returns:
      The size, in bytes, of the volume capacity.

    • volumeProgress

      public final Double volumeProgress()

      Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the cached volume is not restoring or bootstrapping.

      Returns:
      Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the cached volume is not restoring or bootstrapping.

    • sourceSnapshotId

      public final String sourceSnapshotId()

      If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g., snap-78e22663. Otherwise, this field is not included.

      Returns:
      If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g., snap-78e22663. Otherwise, this field is not included.

    • volumeiSCSIAttributes

      public final VolumeiSCSIAttributes volumeiSCSIAttributes()

      An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

      Returns:
      An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

    • createdDate

      public final Instant createdDate()

      The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.

      Returns:
      The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.

    • volumeUsedInBytes

      public final Long volumeUsedInBytes()

      The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

      This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

      If you use a delete tool that overwrites the data on your volume with random data, your usage will not be reduced. This is because the random data is not compressible. If you want to reduce the amount of billed storage on your volume, we recommend overwriting your files with zeros to compress the data to a negligible amount of actual storage.

      Returns:
      The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

      This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

      If you use a delete tool that overwrites the data on your volume with random data, your usage will not be reduced. This is because the random data is not compressible. If you want to reduce the amount of billed storage on your volume, we recommend overwriting your files with zeros to compress the data to a negligible amount of actual storage.

    • kmsKey

      public final String kmsKey()
      Returns the value of the KMSKey property for this object.
      Returns:
      The value of the KMSKey property for this object.

    • targetName

      public final String targetName()

      The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.

      If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

      Returns:
      The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.

      If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

    • toBuilder

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

    • builder

      public static CachediSCSIVolume.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CachediSCSIVolume.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.