com.amazonaws.services.storagegateway.model
Class StorediSCSIVolume

java.lang.Object
  com.amazonaws.services.storagegateway.model.StorediSCSIVolume

All Implemented Interfaces:

Serializable

public class StorediSCSIVolume
extends Object
implements Serializable

Describes an iSCSI stored volume.

See Also:

Serialized Form

Constructor Summary

StorediSCSIVolume()

Method Summary

boolean	equals(Object obj)
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	getVolumeARN() The Amazon Resource Name (ARN) of the storage volume.
String	getVolumeDiskId() The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
String	getVolumeId() The unique identifier of the volume, e.g.
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.
int	hashCode()
Boolean	isPreservedExistingData() Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
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	setVolumeARN(String volumeARN) The Amazon Resource Name (ARN) of the storage volume.
void	setVolumeDiskId(String volumeDiskId) The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
void	setVolumeId(String volumeId) The unique identifier of the volume, e.g.
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	setVolumeStatus(VolumeStatus 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	setVolumeType(VolumeType volumeType) One of the VolumeType enumeration values describing the type of the volume.
String	toString() Returns a string representation of this object; useful for testing and debugging.
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	withVolumeARN(String volumeARN) The Amazon Resource Name (ARN) of the storage volume.
StorediSCSIVolume	withVolumeDiskId(String volumeDiskId) The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
StorediSCSIVolume	withVolumeId(String volumeId) The unique identifier of the volume, e.g.
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	withVolumeStatus(VolumeStatus 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	withVolumeType(VolumeType volumeType) One of the VolumeType enumeration values describing the type of the volume.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StorediSCSIVolume

public StorediSCSIVolume()

Method Detail

getVolumeARN

public String getVolumeARN()

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

Constraints:
Length: 50 - 500

Returns:

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

setVolumeARN

public void setVolumeARN(String volumeARN)

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

Constraints:
Length: 50 - 500

Parameters:

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

withVolumeARN

public StorediSCSIVolume withVolumeARN(String volumeARN)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 50 - 500

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getVolumeId

public String getVolumeId()

The unique identifier of the volume, e.g. vol-AE4B946D.

Constraints:
Length: 12 - 30

Returns:

The unique identifier of the volume, e.g. vol-AE4B946D.

setVolumeId

public void setVolumeId(String volumeId)

The unique identifier of the volume, e.g. vol-AE4B946D.

Constraints:
Length: 12 - 30

Parameters:

volumeId - The unique identifier of the volume, e.g. vol-AE4B946D.

withVolumeId

public StorediSCSIVolume withVolumeId(String volumeId)

The unique identifier of the volume, e.g. vol-AE4B946D.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 12 - 30

Parameters:

volumeId - The unique identifier of the volume, e.g. vol-AE4B946D.

Returns:

A reference to this updated object so that method calls can be chained together.

getVolumeType

public String getVolumeType()

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

Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI

Returns:

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

See Also:

VolumeType

setVolumeType

public void setVolumeType(String volumeType)

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

Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI

Parameters:

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

See Also:

VolumeType

withVolumeType

public StorediSCSIVolume withVolumeType(String volumeType)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VolumeType

setVolumeType

public void setVolumeType(VolumeType volumeType)

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

Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI

Parameters:

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

See Also:

VolumeType

withVolumeType

public StorediSCSIVolume withVolumeType(VolumeType volumeType)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: STORED iSCSI, CACHED iSCSI

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VolumeType

getVolumeStatus

public String getVolumeStatus()

One of the VolumeStatus values that indicates the state of the storage volume.

Constraints:
Allowed Values: CREATING, AVAILABLE, RESTORING, BOOTSTRAPPING, IRRECOVERABLE, PASS THROUGH, RESTORE AND PASS THROUGH, DELETED, WORKING STORAGE NOT CONFIGURED, UPLOAD BUFFER NOT CONFIGURED

Returns:

One of the VolumeStatus values that indicates the state of the storage volume.

See Also:

VolumeStatus

setVolumeStatus

public void setVolumeStatus(String volumeStatus)

One of the VolumeStatus values that indicates the state of the storage volume.

Constraints:
Allowed Values: CREATING, AVAILABLE, RESTORING, BOOTSTRAPPING, IRRECOVERABLE, PASS THROUGH, RESTORE AND PASS THROUGH, DELETED, WORKING STORAGE NOT CONFIGURED, UPLOAD BUFFER NOT CONFIGURED

Parameters:

volumeStatus - One of the VolumeStatus values that indicates the state of the storage volume.

See Also:

VolumeStatus

withVolumeStatus

public StorediSCSIVolume withVolumeStatus(String volumeStatus)

One of the VolumeStatus values that indicates the state of the storage volume.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: CREATING, AVAILABLE, RESTORING, BOOTSTRAPPING, IRRECOVERABLE, PASS THROUGH, RESTORE AND PASS THROUGH, DELETED, WORKING STORAGE NOT CONFIGURED, UPLOAD BUFFER NOT CONFIGURED

Parameters:

volumeStatus - One of the VolumeStatus values that indicates the state of the storage volume.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VolumeStatus

setVolumeStatus

public void setVolumeStatus(VolumeStatus volumeStatus)

One of the VolumeStatus values that indicates the state of the storage volume.

Constraints:
Allowed Values: CREATING, AVAILABLE, RESTORING, BOOTSTRAPPING, IRRECOVERABLE, PASS THROUGH, RESTORE AND PASS THROUGH, DELETED, WORKING STORAGE NOT CONFIGURED, UPLOAD BUFFER NOT CONFIGURED

Parameters:

volumeStatus - One of the VolumeStatus values that indicates the state of the storage volume.

See Also:

VolumeStatus

withVolumeStatus

public StorediSCSIVolume withVolumeStatus(VolumeStatus volumeStatus)

One of the VolumeStatus values that indicates the state of the storage volume.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: CREATING, AVAILABLE, RESTORING, BOOTSTRAPPING, IRRECOVERABLE, PASS THROUGH, RESTORE AND PASS THROUGH, DELETED, WORKING STORAGE NOT CONFIGURED, UPLOAD BUFFER NOT CONFIGURED

Parameters:

volumeStatus - One of the VolumeStatus values that indicates the state of the storage volume.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VolumeStatus

getVolumeSizeInBytes

public Long getVolumeSizeInBytes()

The size of the volume in bytes.

Returns:

The size of the volume in bytes.

setVolumeSizeInBytes

public void setVolumeSizeInBytes(Long volumeSizeInBytes)

The size of the volume in bytes.

Parameters:

volumeSizeInBytes - The size of the volume in bytes.

withVolumeSizeInBytes

public StorediSCSIVolume withVolumeSizeInBytes(Long volumeSizeInBytes)

The size of the volume in bytes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

volumeSizeInBytes - The size of the volume in bytes.

Returns:

A reference to this updated object so that method calls can be chained together.

getVolumeProgress

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.

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.

setVolumeProgress

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.

Parameters:

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.

withVolumeProgress

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getVolumeDiskId

public String getVolumeDiskId()

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

Constraints:
Length: 1 - 300

Returns:

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

setVolumeDiskId

public void setVolumeDiskId(String volumeDiskId)

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

Constraints:
Length: 1 - 300

Parameters:

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

withVolumeDiskId

public StorediSCSIVolume withVolumeDiskId(String volumeDiskId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 300

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getSourceSnapshotId

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.

Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z

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.

setSourceSnapshotId

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.

Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z

Parameters:

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.

withSourceSnapshotId

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

isPreservedExistingData

public Boolean isPreservedExistingData()

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

setPreservedExistingData

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

Parameters:

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

Valid Values: true, false

withPreservedExistingData

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Valid Values: true, false

Returns:

A reference to this updated object so that method calls can be chained together.

getPreservedExistingData

public Boolean getPreservedExistingData()

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

getVolumeiSCSIAttributes

public VolumeiSCSIAttributes getVolumeiSCSIAttributes()

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.

setVolumeiSCSIAttributes

public void setVolumeiSCSIAttributes(VolumeiSCSIAttributes volumeiSCSIAttributes)

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Parameters:

volumeiSCSIAttributes - An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

withVolumeiSCSIAttributes

public StorediSCSIVolume withVolumeiSCSIAttributes(VolumeiSCSIAttributes volumeiSCSIAttributes)

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Returns a reference to this object so that method calls can be chained together.

Parameters:

volumeiSCSIAttributes - An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object