CachediSCSIVolume (AWS Java SDK :: Services :: AWS Storage Gateway 2.20.162 API)

java.lang.Object
- software.amazon.awssdk.services.storagegateway.model.CachediSCSIVolume

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CachediSCSIVolume.Builder,CachediSCSIVolume>

@Generated(value="software.amazon.awssdk:codegen")
public final class CachediSCSIVolume
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CachediSCSIVolume.Builder,CachediSCSIVolume>

Describes an iSCSI cached volume.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CachediSCSIVolume.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CachediSCSIVolume.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CachediSCSIVolume.Builder`	`builder()`
`Instant`	`createdDate()` The date the volume was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`kmsKey()` Returns the value of the KMSKey property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CachediSCSIVolume.Builder>`	`serializableBuilderClass()`
`String`	`sourceSnapshotId()` If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g., snap-78e22663.
`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.
`CachediSCSIVolume.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`volumeARN()` The Amazon Resource Name (ARN) of the storage volume.
`String`	`volumeAttachmentStatus()` A value that indicates whether a storage volume is attached to or detached from a gateway.
`String`	`volumeId()` The unique identifier of the volume, e.g., vol-AE4B946D.
`VolumeiSCSIAttributes`	`volumeiSCSIAttributes()` An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
`Double`	`volumeProgress()` Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred.
`Long`	`volumeSizeInBytes()` The size, in bytes, of the volume capacity.
`String`	`volumeStatus()` One of the VolumeStatus values that indicates the state of the storage volume.
`String`	`volumeType()` One of the VolumeType enumeration values that describes the type of the volume.
`Long`	`volumeUsedInBytes()` The size of the data stored on the volume in bytes.

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
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CachediSCSIVolume.Builder,CachediSCSIVolume>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class CachediSCSIVolume

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

volumeARN

volumeId

volumeType

volumeStatus

volumeAttachmentStatus

volumeSizeInBytes

volumeProgress

sourceSnapshotId

volumeiSCSIAttributes

createdDate

volumeUsedInBytes

kmsKey

targetName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields