software.amazon.awssdk.services.storagegateway.model

Class StorediSCSIVolume

java.lang.Object

software.amazon.awssdk.services.storagegateway.model.StorediSCSIVolume

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StorediSCSIVolume.Builder,StorediSCSIVolume>

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

Describes an iSCSI stored volume.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StorediSCSIVolume.Builder

Method Summary

Modifier and Type	Method and Description
static StorediSCSIVolume.Builder	builder()
Instant	createdDate() The date the volume was created.
boolean	equals(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.
Boolean	preservedExistingData() Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
List<SdkField<?>>	sdkFields()
static Class<? extends StorediSCSIVolume.Builder>	serializableBuilderClass()
String	sourceSnapshotId() If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g.
String	targetName() The name of the iSCSI target that is used by an initiator to connect to a volume and used as a suffix for the target ARN.
StorediSCSIVolume.Builder	toBuilder()
String	toString()
String	volumeARN() The Amazon Resource Name (ARN) of the storage volume.
String	volumeAttachmentStatus() A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
String	volumeDiskId() The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
String	volumeId() The unique identifier of the volume, e.g.
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 of the volume in bytes.
String	volumeStatus() One of the VolumeStatus values that indicates the state of the storage volume.
String	volumeType() One of the VolumeType enumeration values describing 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 String volumeARN()

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

Returns:

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

volumeId

public 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 String volumeType()

One of the VolumeType enumeration values describing the type of the volume.

Returns:

One of the VolumeType enumeration values describing the type of the volume.

volumeStatus

public 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 String volumeAttachmentStatus()

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.

Returns:

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.

volumeSizeInBytes

public Long volumeSizeInBytes()

The size of the volume in bytes.

Returns:

The size of the volume in bytes.

volumeProgress

public 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 stored 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 stored volume is not restoring or bootstrapping.

volumeDiskId

public String volumeDiskId()

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Returns:

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

sourceSnapshotId

public String sourceSnapshotId()

If the stored 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 stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

preservedExistingData

public Boolean preservedExistingData()

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true, false

Returns:

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true, false

volumeiSCSIAttributes

public 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 Instant createdDate()

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

Returns:

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

volumeUsedInBytes

public Long volumeUsedInBytes()

The size of the data stored on the volume in bytes.

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

Returns:

The size of the data stored on the volume in bytes.

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

kmsKey

public String kmsKey()

Returns the value of the KMSKey property for this object.

Returns:

The value of the KMSKey property for this object.

targetName

public String targetName()

The name of the iSCSI target that is 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 .

Returns:

The name of the iSCSI target that is 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 .

toBuilder

public StorediSCSIVolume.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StorediSCSIVolume.Builder,StorediSCSIVolume>

builder

public static StorediSCSIVolume.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo