Class StorediSCSIVolume
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StorediSCSIVolume.Builder,
StorediSCSIVolume>
Describes an iSCSI stored volume.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic StorediSCSIVolume.Builder
builder()
final Instant
The date the volume was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
kmsKey()
Returns the value of the KMSKey property for this object.final Boolean
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.static Class
<? extends StorediSCSIVolume.Builder> final String
If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g.final String
The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.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
The Amazon Resource Name (ARN) of the storage volume.final String
A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.final String
The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.final String
volumeId()
The unique identifier of the volume, e.g., vol-AE4B946D.final VolumeiSCSIAttributes
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.final Double
Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred.final Long
The size of the volume in bytes.final String
One of the VolumeStatus values that indicates the state of the storage volume.final String
One of the VolumeType enumeration values describing the type of the volume.final Long
The size of the data stored on the volume in bytes.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
volumeARN
The Amazon Resource Name (ARN) of the storage volume.
- Returns:
- The Amazon Resource Name (ARN) of the storage volume.
-
volumeId
The unique identifier of the volume, e.g., vol-AE4B946D.
- Returns:
- The unique identifier of the volume, e.g., vol-AE4B946D.
-
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
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
A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching 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, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.
-
volumeSizeInBytes
The size of the volume in bytes.
- Returns:
- The size of the volume in bytes.
-
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
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
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
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
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
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
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.
- 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.
-
kmsKey
Returns the value of the KMSKey property for this object.- Returns:
- The value of the KMSKey property for this object.
-
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 ofarn: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 ofarn: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
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<StorediSCSIVolume.Builder,
StorediSCSIVolume> - 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
-