CachediSCSIVolume (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.storagegateway.model.CachediSCSIVolume

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CachediSCSIVolume
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes an iSCSI cached volume.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CachediSCSIVolume()

Constructors
Constructor and Description
`CachediSCSIVolume()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CachediSCSIVolume`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedDate()` The date the volume was created.
`String`	`getSourceSnapshotId()` If the cached 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`	`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, 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.
`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`	`setSourceSnapshotId(String sourceSnapshotId)` If the cached 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`	`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, 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.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CachediSCSIVolume`	`withCreatedDate(Date createdDate)` The date the volume was created.
`CachediSCSIVolume`	`withSourceSnapshotId(String sourceSnapshotId)` If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g.
`CachediSCSIVolume`	`withVolumeARN(String volumeARN)` The Amazon Resource Name (ARN) of the storage volume.
`CachediSCSIVolume`	`withVolumeId(String volumeId)` The unique identifier of the volume, e.g.
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CachediSCSIVolume
```
public CachediSCSIVolume()
```
- Method Detail
  - setVolumeARN
```
public void setVolumeARN(String volumeARN)
```
    The Amazon Resource Name (ARN) of the storage volume.
    
    Parameters:
    
    volumeARN - The Amazon Resource Name (ARN) of the storage volume.
  - getVolumeARN
```
public String getVolumeARN()
```
    The Amazon Resource Name (ARN) of the storage volume.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the storage volume.
  - withVolumeARN
```
public CachediSCSIVolume withVolumeARN(String volumeARN)
```
    The Amazon Resource Name (ARN) of the storage volume.
    
    Parameters:
    
    volumeARN - The Amazon Resource Name (ARN) of the storage volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeId
```
public void setVolumeId(String volumeId)
```
    The unique identifier of the volume, e.g. vol-AE4B946D.
    
    Parameters:
    
    volumeId - The unique identifier of the volume, e.g. vol-AE4B946D.
  - getVolumeId
```
public String getVolumeId()
```
    The unique identifier of the volume, e.g. vol-AE4B946D.
    
    Returns:
    
    The unique identifier of the volume, e.g. vol-AE4B946D.
  - withVolumeId
```
public CachediSCSIVolume withVolumeId(String volumeId)
```
    The unique identifier of the volume, e.g. vol-AE4B946D.
    
    Parameters:
    
    volumeId - The unique identifier of the volume, e.g. vol-AE4B946D.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeType
```
public void setVolumeType(String volumeType)
```
    One of the VolumeType enumeration values that describes the type of the volume.
    
    Parameters:
    
    volumeType - One of the VolumeType enumeration values that describes the type of the volume.
  - getVolumeType
```
public String getVolumeType()
```
    One of the VolumeType enumeration values that describes the type of the volume.
    
    Returns:
    
    One of the VolumeType enumeration values that describes the type of the volume.
  - withVolumeType
```
public CachediSCSIVolume withVolumeType(String volumeType)
```
    One of the VolumeType enumeration values that describes the type of the volume.
    
    Parameters:
    
    volumeType - One of the VolumeType enumeration values that describes the type of the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeStatus
```
public void setVolumeStatus(String volumeStatus)
```
    One of the VolumeStatus values that indicates the state of the storage volume.
    
    Parameters:
    
    volumeStatus - One of the VolumeStatus values that indicates the state of the storage volume.
  - getVolumeStatus
```
public String getVolumeStatus()
```
    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.
  - withVolumeStatus
```
public CachediSCSIVolume withVolumeStatus(String volumeStatus)
```
    One of the VolumeStatus values that indicates the state of the storage volume.
    
    Parameters:
    
    volumeStatus - One of the VolumeStatus values that indicates the state of the storage volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeSizeInBytes
```
public void setVolumeSizeInBytes(Long volumeSizeInBytes)
```
    The size, in bytes, of the volume capacity.
    
    Parameters:
    
    volumeSizeInBytes - The size, in bytes, of the volume capacity.
  - getVolumeSizeInBytes
```
public Long getVolumeSizeInBytes()
```
    The size, in bytes, of the volume capacity.
    
    Returns:
    
    The size, in bytes, of the volume capacity.
  - withVolumeSizeInBytes
```
public CachediSCSIVolume withVolumeSizeInBytes(Long volumeSizeInBytes)
```
    The size, in bytes, of the volume capacity.
    
    Parameters:
    
    volumeSizeInBytes - The size, in bytes, of the volume capacity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 cached 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 cached volume is not restoring or bootstrapping.
  - 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 cached 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 cached volume is not restoring or bootstrapping.
  - withVolumeProgress
```
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.
    
    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 cached volume is not restoring or bootstrapping.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceSnapshotId
```
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.
    
    Parameters:
    
    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.
  - getSourceSnapshotId
```
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.
    
    Returns:
    
    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.
  - withSourceSnapshotId
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withVolumeiSCSIAttributes
```
public CachediSCSIVolume withVolumeiSCSIAttributes(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
    
    Parameters:
    
    createdDate - The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
    
    Returns:
    
    The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
  - withCreatedDate
```
public CachediSCSIVolume withCreatedDate(Date createdDate)
```
    The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
    
    Parameters:
    
    createdDate - The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
    
    Returns:
    
    Returns a reference to this 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CachediSCSIVolume clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CachediSCSIVolume

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CachediSCSIVolume

Method Detail

setVolumeARN

getVolumeARN

withVolumeARN

setVolumeId

getVolumeId

withVolumeId

setVolumeType

getVolumeType

withVolumeType

setVolumeStatus

getVolumeStatus

withVolumeStatus

setVolumeSizeInBytes

getVolumeSizeInBytes

withVolumeSizeInBytes

setVolumeProgress

getVolumeProgress

withVolumeProgress

setSourceSnapshotId

getSourceSnapshotId

withSourceSnapshotId

setVolumeiSCSIAttributes

getVolumeiSCSIAttributes

withVolumeiSCSIAttributes

setCreatedDate

getCreatedDate

withCreatedDate

toString

equals

hashCode

clone

marshall