@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CachediSCSIVolume extends Object implements Serializable, Cloneable, StructuredPojo
Describes an iSCSI cached volume.
Constructor and Description |
---|
CachediSCSIVolume() |
Modifier and Type | Method and Description |
---|---|
CachediSCSIVolume |
clone() |
boolean |
equals(Object obj) |
Date |
getCreatedDate()
The date the volume was created.
|
String |
getKMSKey() |
String |
getSourceSnapshotId()
If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g., snap-78e22663.
|
String |
getTargetName()
The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.
|
String |
getVolumeARN()
The Amazon Resource Name (ARN) of the storage volume.
|
String |
getVolumeAttachmentStatus()
A value that indicates whether a storage volume is attached to or detached from a gateway.
|
String |
getVolumeId()
The unique identifier of the volume, e.g., vol-AE4B946D.
|
VolumeiSCSIAttributes |
getVolumeiSCSIAttributes()
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
|
Double |
getVolumeProgress()
Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of
data transferred.
|
Long |
getVolumeSizeInBytes()
The size, in bytes, of the volume capacity.
|
String |
getVolumeStatus()
One of the VolumeStatus values that indicates the state of the storage volume.
|
String |
getVolumeType()
One of the VolumeType enumeration values that describes the type of the volume.
|
Long |
getVolumeUsedInBytes()
The size of the data stored on the volume in bytes.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCreatedDate(Date createdDate)
The date the volume was created.
|
void |
setKMSKey(String kMSKey) |
void |
setSourceSnapshotId(String sourceSnapshotId)
If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g., snap-78e22663.
|
void |
setTargetName(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.
|
void |
setVolumeARN(String volumeARN)
The Amazon Resource Name (ARN) of the storage volume.
|
void |
setVolumeAttachmentStatus(String volumeAttachmentStatus)
A value that indicates whether a storage volume is attached to or detached from a gateway.
|
void |
setVolumeId(String volumeId)
The unique identifier of the volume, e.g., vol-AE4B946D.
|
void |
setVolumeiSCSIAttributes(VolumeiSCSIAttributes volumeiSCSIAttributes)
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
|
void |
setVolumeProgress(Double volumeProgress)
Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of
data transferred.
|
void |
setVolumeSizeInBytes(Long volumeSizeInBytes)
The size, in bytes, of the volume capacity.
|
void |
setVolumeStatus(String volumeStatus)
One of the VolumeStatus values that indicates the state of the storage volume.
|
void |
setVolumeType(String volumeType)
One of the VolumeType enumeration values that describes the type of the volume.
|
void |
setVolumeUsedInBytes(Long volumeUsedInBytes)
The size of the data stored on the volume in bytes.
|
String |
toString()
Returns a string representation of this object.
|
CachediSCSIVolume |
withCreatedDate(Date createdDate)
The date the volume was created.
|
CachediSCSIVolume |
withKMSKey(String kMSKey) |
CachediSCSIVolume |
withSourceSnapshotId(String sourceSnapshotId)
If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g., snap-78e22663.
|
CachediSCSIVolume |
withTargetName(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 |
withVolumeARN(String volumeARN)
The Amazon Resource Name (ARN) of the storage volume.
|
CachediSCSIVolume |
withVolumeAttachmentStatus(String volumeAttachmentStatus)
A value that indicates whether a storage volume is attached to or detached from a gateway.
|
CachediSCSIVolume |
withVolumeId(String volumeId)
The unique identifier of the volume, e.g., vol-AE4B946D.
|
CachediSCSIVolume |
withVolumeiSCSIAttributes(VolumeiSCSIAttributes volumeiSCSIAttributes)
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
|
CachediSCSIVolume |
withVolumeProgress(Double volumeProgress)
Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of
data transferred.
|
CachediSCSIVolume |
withVolumeSizeInBytes(Long volumeSizeInBytes)
The size, in bytes, of the volume capacity.
|
CachediSCSIVolume |
withVolumeStatus(String volumeStatus)
One of the VolumeStatus values that indicates the state of the storage volume.
|
CachediSCSIVolume |
withVolumeType(String volumeType)
One of the VolumeType enumeration values that describes the type of the volume.
|
CachediSCSIVolume |
withVolumeUsedInBytes(Long volumeUsedInBytes)
The size of the data stored on the volume in bytes.
|
public void setVolumeARN(String volumeARN)
The Amazon Resource Name (ARN) of the storage volume.
volumeARN
- The Amazon Resource Name (ARN) of the storage volume.public String getVolumeARN()
The Amazon Resource Name (ARN) of the storage volume.
public CachediSCSIVolume withVolumeARN(String volumeARN)
The Amazon Resource Name (ARN) of the storage volume.
volumeARN
- The Amazon Resource Name (ARN) of the storage volume.public void setVolumeId(String volumeId)
The unique identifier of the volume, e.g., vol-AE4B946D.
volumeId
- The unique identifier of the volume, e.g., vol-AE4B946D.public String getVolumeId()
The unique identifier of the volume, e.g., vol-AE4B946D.
public CachediSCSIVolume withVolumeId(String volumeId)
The unique identifier of the volume, e.g., vol-AE4B946D.
volumeId
- The unique identifier of the volume, e.g., vol-AE4B946D.public void setVolumeType(String volumeType)
One of the VolumeType enumeration values that describes the type of the volume.
volumeType
- One of the VolumeType enumeration values that describes the type of the volume.public String getVolumeType()
One of the VolumeType enumeration values that describes the type of the volume.
public CachediSCSIVolume withVolumeType(String volumeType)
One of the VolumeType enumeration values that describes the type of the volume.
volumeType
- One of the VolumeType enumeration values that describes the type of the volume.public void setVolumeStatus(String volumeStatus)
One of the VolumeStatus values that indicates the state of the storage volume.
volumeStatus
- One of the VolumeStatus values that indicates the state of the storage volume.public String getVolumeStatus()
One of the VolumeStatus values that indicates the state of the storage volume.
public CachediSCSIVolume withVolumeStatus(String volumeStatus)
One of the VolumeStatus values that indicates the state of the storage volume.
volumeStatus
- One of the VolumeStatus values that indicates the state of the storage volume.public void setVolumeAttachmentStatus(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.
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 String getVolumeAttachmentStatus()
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 CachediSCSIVolume withVolumeAttachmentStatus(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.
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 void setVolumeSizeInBytes(Long volumeSizeInBytes)
The size, in bytes, of the volume capacity.
volumeSizeInBytes
- The size, in bytes, of the volume capacity.public Long getVolumeSizeInBytes()
The size, in bytes, of the volume capacity.
public CachediSCSIVolume withVolumeSizeInBytes(Long volumeSizeInBytes)
The size, in bytes, of the volume capacity.
volumeSizeInBytes
- The size, in bytes, of the volume capacity.public void setVolumeProgress(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.
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 Double getVolumeProgress()
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 CachediSCSIVolume withVolumeProgress(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.
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 void setSourceSnapshotId(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.
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 String getSourceSnapshotId()
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 CachediSCSIVolume withSourceSnapshotId(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.
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 void setVolumeiSCSIAttributes(VolumeiSCSIAttributes volumeiSCSIAttributes)
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
volumeiSCSIAttributes
- An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored
volume.public VolumeiSCSIAttributes getVolumeiSCSIAttributes()
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
public CachediSCSIVolume withVolumeiSCSIAttributes(VolumeiSCSIAttributes volumeiSCSIAttributes)
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
volumeiSCSIAttributes
- An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored
volume.public void setCreatedDate(Date createdDate)
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.
createdDate
- The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.public Date getCreatedDate()
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.
public CachediSCSIVolume withCreatedDate(Date createdDate)
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.
createdDate
- The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.public void setVolumeUsedInBytes(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.
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.
public Long getVolumeUsedInBytes()
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.
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.
public CachediSCSIVolume withVolumeUsedInBytes(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.
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.
public void setKMSKey(String kMSKey)
kMSKey
- public String getKMSKey()
public CachediSCSIVolume withKMSKey(String kMSKey)
kMSKey
- public void setTargetName(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
- 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.
public String getTargetName()
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 withTargetName(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
- 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.
public String toString()
toString
in class Object
Object.toString()
public CachediSCSIVolume clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.