@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StorediSCSIVolume extends Object implements Serializable, Cloneable, StructuredPojo
Describes an iSCSI stored volume.
Constructor and Description |
---|
StorediSCSIVolume() |
Modifier and Type | Method and Description |
---|---|
StorediSCSIVolume |
clone() |
boolean |
equals(Object obj) |
Date |
getCreatedDate()
The date the volume was created.
|
String |
getKMSKey() |
Boolean |
getPreservedExistingData()
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
|
String |
getSourceSnapshotId()
If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g.
|
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, detached from, or is in the process of detaching
from a gateway.
|
String |
getVolumeDiskId()
The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
|
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 of the volume in bytes.
|
String |
getVolumeStatus()
One of the VolumeStatus values that indicates the state of the storage volume.
|
String |
getVolumeType()
One of the VolumeType enumeration values describing the type of the volume.
|
Long |
getVolumeUsedInBytes()
The size of the data stored on the volume in bytes.
|
int |
hashCode() |
Boolean |
isPreservedExistingData()
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
|
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 |
setPreservedExistingData(Boolean preservedExistingData)
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
|
void |
setSourceSnapshotId(String sourceSnapshotId)
If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g.
|
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, detached from, or is in the process of detaching
from a gateway.
|
void |
setVolumeDiskId(String volumeDiskId)
The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
|
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 of the volume in bytes.
|
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 describing 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.
|
StorediSCSIVolume |
withCreatedDate(Date createdDate)
The date the volume was created.
|
StorediSCSIVolume |
withKMSKey(String kMSKey) |
StorediSCSIVolume |
withPreservedExistingData(Boolean preservedExistingData)
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
|
StorediSCSIVolume |
withSourceSnapshotId(String sourceSnapshotId)
If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g.
|
StorediSCSIVolume |
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.
|
StorediSCSIVolume |
withVolumeARN(String volumeARN)
The Amazon Resource Name (ARN) of the storage volume.
|
StorediSCSIVolume |
withVolumeAttachmentStatus(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.
|
StorediSCSIVolume |
withVolumeDiskId(String volumeDiskId)
The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
|
StorediSCSIVolume |
withVolumeId(String volumeId)
The unique identifier of the volume, e.g., vol-AE4B946D.
|
StorediSCSIVolume |
withVolumeiSCSIAttributes(VolumeiSCSIAttributes volumeiSCSIAttributes)
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
|
StorediSCSIVolume |
withVolumeProgress(Double volumeProgress)
Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of
data transferred.
|
StorediSCSIVolume |
withVolumeSizeInBytes(Long volumeSizeInBytes)
The size of the volume in bytes.
|
StorediSCSIVolume |
withVolumeStatus(String volumeStatus)
One of the VolumeStatus values that indicates the state of the storage volume.
|
StorediSCSIVolume |
withVolumeType(String volumeType)
One of the VolumeType enumeration values describing the type of the volume.
|
StorediSCSIVolume |
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 StorediSCSIVolume 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 StorediSCSIVolume 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 describing the type of the volume.
volumeType
- One of the VolumeType enumeration values describing the type of the volume.public String getVolumeType()
One of the VolumeType enumeration values describing the type of the volume.
public StorediSCSIVolume withVolumeType(String volumeType)
One of the VolumeType enumeration values describing the type of the volume.
volumeType
- One of the VolumeType enumeration values describing 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 StorediSCSIVolume 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, detached from, or is in the process of detaching 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, detached from, or is in the process of
detaching 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, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.
public StorediSCSIVolume withVolumeAttachmentStatus(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. For more information, see Moving your volumes to a different gateway.
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.public void setVolumeSizeInBytes(Long volumeSizeInBytes)
The size of the volume in bytes.
volumeSizeInBytes
- The size of the volume in bytes.public Long getVolumeSizeInBytes()
The size of the volume in bytes.
public StorediSCSIVolume withVolumeSizeInBytes(Long volumeSizeInBytes)
The size of the volume in bytes.
volumeSizeInBytes
- The size of the volume in bytes.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 stored 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 stored 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 stored volume is not restoring or bootstrapping.
public StorediSCSIVolume 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 stored 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 stored volume is not restoring or
bootstrapping.public void setVolumeDiskId(String volumeDiskId)
The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
volumeDiskId
- The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.public String getVolumeDiskId()
The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
public StorediSCSIVolume withVolumeDiskId(String volumeDiskId)
The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
volumeDiskId
- The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.public void setSourceSnapshotId(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.
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.public String getSourceSnapshotId()
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.
public StorediSCSIVolume withSourceSnapshotId(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.
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.public void setPreservedExistingData(Boolean preservedExistingData)
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
Valid Values: true
| false
preservedExistingData
- Indicates if when the stored volume was created, existing data on the underlying local disk was
preserved.
Valid Values: true
| false
public Boolean getPreservedExistingData()
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
Valid Values: true
| false
Valid Values: true
| false
public StorediSCSIVolume withPreservedExistingData(Boolean preservedExistingData)
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
Valid Values: true
| false
preservedExistingData
- Indicates if when the stored volume was created, existing data on the underlying local disk was
preserved.
Valid Values: true
| false
public Boolean isPreservedExistingData()
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
Valid Values: true
| false
Valid Values: true
| false
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 StorediSCSIVolume 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 StorediSCSIVolume 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.
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.
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.
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 StorediSCSIVolume 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.
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.
public void setKMSKey(String kMSKey)
kMSKey
- public String getKMSKey()
public StorediSCSIVolume 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 StorediSCSIVolume 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 StorediSCSIVolume clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.