@Generated(value="software.amazon.awssdk:codegen") public final class CachediSCSIVolume extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CachediSCSIVolume.Builder,CachediSCSIVolume>
Describes an iSCSI cached volume.
Modifier and Type | Class and Description |
---|---|
static interface |
CachediSCSIVolume.Builder |
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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<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()
Take this object and create a builder that contains all of the current property values of this object.
|
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.
|
copy
public final String volumeARN()
The Amazon Resource Name (ARN) of the storage volume.
public final String volumeId()
The unique identifier of the volume, e.g., vol-AE4B946D.
public final String volumeType()
One of the VolumeType enumeration values that describes the type of the volume.
public final String volumeStatus()
One of the VolumeStatus values that indicates the state of the storage volume.
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.
public final Long volumeSizeInBytes()
The size, in bytes, of the volume capacity.
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.
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.
public final VolumeiSCSIAttributes volumeiSCSIAttributes()
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
public final Instant createdDate()
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.
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.
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.
public final String kmsKey()
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.
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.
public CachediSCSIVolume.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CachediSCSIVolume.Builder,CachediSCSIVolume>
public static CachediSCSIVolume.Builder builder()
public static Class<? extends CachediSCSIVolume.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.