Volume (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.Volume

All Implemented Interfaces:

Serializable
```
public class Volume
extends Object
implements Serializable
```
Represents an Amazon Elastic Block Storage (EBS) volume.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Volume()

Constructors
Constructor and Description
`Volume()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`List<VolumeAttachment>`	`getAttachments()` Information on what this volume is attached to.
`String`	`getAvailabilityZone()` Availability zone in which this volume was created.
`Date`	`getCreateTime()` Timestamp when volume creation was initiated.
`Integer`	`getIops()` Returns the value of the Iops property for this object.
`Integer`	`getSize()` The size of this volume, in gigabytes.
`String`	`getSnapshotId()` Optional snapshot from which this volume was created.
`String`	`getState()` State of this volume (e.g., creating, available).
`List<Tag>`	`getTags()` A list of tags for the Volume.
`String`	`getVolumeId()` The unique ID of this volume.
`String`	`getVolumeType()` Returns the value of the VolumeType property for this object.
`int`	`hashCode()`
`void`	`setAttachments(Collection<VolumeAttachment> attachments)` Information on what this volume is attached to.
`void`	`setAvailabilityZone(String availabilityZone)` Availability zone in which this volume was created.
`void`	`setCreateTime(Date createTime)` Timestamp when volume creation was initiated.
`void`	`setIops(Integer iops)` Sets the value of the Iops property for this object.
`void`	`setSize(Integer size)` The size of this volume, in gigabytes.
`void`	`setSnapshotId(String snapshotId)` Optional snapshot from which this volume was created.
`void`	`setState(String state)` State of this volume (e.g., creating, available).
`void`	`setState(VolumeState state)` State of this volume (e.g., creating, available).
`void`	`setTags(Collection<Tag> tags)` A list of tags for the Volume.
`void`	`setVolumeId(String volumeId)` The unique ID of this volume.
`void`	`setVolumeType(String volumeType)` Sets the value of the VolumeType property for this object.
`void`	`setVolumeType(VolumeType volumeType)` Sets the value of the VolumeType property for this object.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Volume`	`withAttachments(Collection<VolumeAttachment> attachments)` Information on what this volume is attached to.
`Volume`	`withAttachments(VolumeAttachment... attachments)` Information on what this volume is attached to.
`Volume`	`withAvailabilityZone(String availabilityZone)` Availability zone in which this volume was created.
`Volume`	`withCreateTime(Date createTime)` Timestamp when volume creation was initiated.
`Volume`	`withIops(Integer iops)` Sets the value of the Iops property for this object.
`Volume`	`withSize(Integer size)` The size of this volume, in gigabytes.
`Volume`	`withSnapshotId(String snapshotId)` Optional snapshot from which this volume was created.
`Volume`	`withState(String state)` State of this volume (e.g., creating, available).
`Volume`	`withState(VolumeState state)` State of this volume (e.g., creating, available).
`Volume`	`withTags(Collection<Tag> tags)` A list of tags for the Volume.
`Volume`	`withTags(Tag... tags)` A list of tags for the Volume.
`Volume`	`withVolumeId(String volumeId)` The unique ID of this volume.
`Volume`	`withVolumeType(String volumeType)` Sets the value of the VolumeType property for this object.
`Volume`	`withVolumeType(VolumeType volumeType)` Sets the value of the VolumeType property for this object.

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

- Constructor Detail
  - Volume
```
public Volume()
```
- Method Detail
  - getVolumeId
```
public String getVolumeId()
```
    The unique ID of this volume.
    
    Returns:
    The unique ID of this volume.
  - setVolumeId
```
public void setVolumeId(String volumeId)
```
    The unique ID of this volume.
    
    Parameters:
    volumeId - The unique ID of this volume.
  - withVolumeId
```
public Volume withVolumeId(String volumeId)
```
    The unique ID of this volume.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    volumeId - The unique ID of this volume.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSize
```
public Integer getSize()
```
    The size of this volume, in gigabytes.
    
    Returns:
    The size of this volume, in gigabytes.
  - setSize
```
public void setSize(Integer size)
```
    The size of this volume, in gigabytes.
    
    Parameters:
    size - The size of this volume, in gigabytes.
  - withSize
```
public Volume withSize(Integer size)
```
    The size of this volume, in gigabytes.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    size - The size of this volume, in gigabytes.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSnapshotId
```
public String getSnapshotId()
```
    Optional snapshot from which this volume was created.
    
    Returns:
    Optional snapshot from which this volume was created.
  - setSnapshotId
```
public void setSnapshotId(String snapshotId)
```
    Optional snapshot from which this volume was created.
    
    Parameters:
    snapshotId - Optional snapshot from which this volume was created.
  - withSnapshotId
```
public Volume withSnapshotId(String snapshotId)
```
    Optional snapshot from which this volume was created.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    snapshotId - Optional snapshot from which this volume was created.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAvailabilityZone
```
public String getAvailabilityZone()
```
    Availability zone in which this volume was created.
    
    Returns:
    Availability zone in which this volume was created.
  - setAvailabilityZone
```
public void setAvailabilityZone(String availabilityZone)
```
    Availability zone in which this volume was created.
    
    Parameters:
    availabilityZone - Availability zone in which this volume was created.
  - withAvailabilityZone
```
public Volume withAvailabilityZone(String availabilityZone)
```
    Availability zone in which this volume was created.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    availabilityZone - Availability zone in which this volume was created.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getState
```
public String getState()
```
    State of this volume (e.g., creating, available).
    Constraints:
    Allowed Values: creating, available, in-use, deleting, deleted, error
    
    Returns:
    State of this volume (e.g., creating, available).
    See Also:
    VolumeState
  - setState
```
public void setState(String state)
```
    State of this volume (e.g., creating, available).
    Constraints:
    Allowed Values: creating, available, in-use, deleting, deleted, error
    
    Parameters:
    state - State of this volume (e.g., creating, available).
    See Also:
    VolumeState
  - withState
```
public Volume withState(String state)
```
    State of this volume (e.g., creating, available).
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: creating, available, in-use, deleting, deleted, error
    
    Parameters:
    state - State of this volume (e.g., creating, available).
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    VolumeState
  - setState
```
public void setState(VolumeState state)
```
    State of this volume (e.g., creating, available).
    Constraints:
    Allowed Values: creating, available, in-use, deleting, deleted, error
    
    Parameters:
    state - State of this volume (e.g., creating, available).
    See Also:
    VolumeState
  - withState
```
public Volume withState(VolumeState state)
```
    State of this volume (e.g., creating, available).
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: creating, available, in-use, deleting, deleted, error
    
    Parameters:
    state - State of this volume (e.g., creating, available).
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    VolumeState
  - getCreateTime
```
public Date getCreateTime()
```
    Timestamp when volume creation was initiated.
    
    Returns:
    Timestamp when volume creation was initiated.
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
    Timestamp when volume creation was initiated.
    
    Parameters:
    createTime - Timestamp when volume creation was initiated.
  - withCreateTime
```
public Volume withCreateTime(Date createTime)
```
    Timestamp when volume creation was initiated.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    createTime - Timestamp when volume creation was initiated.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAttachments
```
public List<VolumeAttachment> getAttachments()
```
    Information on what this volume is attached to.
    
    Returns:
    Information on what this volume is attached to.
  - setAttachments
```
public void setAttachments(Collection<VolumeAttachment> attachments)
```
    Information on what this volume is attached to.
    
    Parameters:
    attachments - Information on what this volume is attached to.
  - withAttachments
```
public Volume withAttachments(VolumeAttachment... attachments)
```
    Information on what this volume is attached to.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    attachments - Information on what this volume is attached to.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withAttachments
```
public Volume withAttachments(Collection<VolumeAttachment> attachments)
```
    Information on what this volume is attached to.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    attachments - Information on what this volume is attached to.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    A list of tags for the Volume.
    
    Returns:
    A list of tags for the Volume.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of tags for the Volume.
    
    Parameters:
    tags - A list of tags for the Volume.
  - withTags
```
public Volume withTags(Tag... tags)
```
    A list of tags for the Volume.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tags - A list of tags for the Volume.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withTags
```
public Volume withTags(Collection<Tag> tags)
```
    A list of tags for the Volume.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tags - A list of tags for the Volume.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getVolumeType
```
public String getVolumeType()
```
    Returns the value of the VolumeType property for this object.
    Constraints:
    Allowed Values: standard, io1
    
    Returns:
    The value of the VolumeType property for this object.
    See Also:
    VolumeType
  - setVolumeType
```
public void setVolumeType(String volumeType)
```
    Sets the value of the VolumeType property for this object.
    Constraints:
    Allowed Values: standard, io1
    
    Parameters:
    volumeType - The new value for the VolumeType property for this object.
    See Also:
    VolumeType
  - withVolumeType
```
public Volume withVolumeType(String volumeType)
```
    Sets the value of the VolumeType property for this object.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: standard, io1
    
    Parameters:
    volumeType - The new value for the VolumeType property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    VolumeType
  - setVolumeType
```
public void setVolumeType(VolumeType volumeType)
```
    Sets the value of the VolumeType property for this object.
    Constraints:
    Allowed Values: standard, io1
    
    Parameters:
    volumeType - The new value for the VolumeType property for this object.
    See Also:
    VolumeType
  - withVolumeType
```
public Volume withVolumeType(VolumeType volumeType)
```
    Sets the value of the VolumeType property for this object.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: standard, io1
    
    Parameters:
    volumeType - The new value for the VolumeType property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    VolumeType
  - getIops
```
public Integer getIops()
```
    Returns the value of the Iops property for this object.
    
    Returns:
    The value of the Iops property for this object.
  - setIops
```
public void setIops(Integer iops)
```
    Sets the value of the Iops property for this object.
    
    Parameters:
    iops - The new value for the Iops property for this object.
  - withIops
```
public Volume withIops(Integer iops)
```
    Sets the value of the Iops property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    iops - The new value for the Iops property for this object.
    
    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

Did this page help you?

Class Volume

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Volume

Method Detail

getVolumeId

setVolumeId

withVolumeId

getSize

setSize

withSize

getSnapshotId

setSnapshotId

withSnapshotId

getAvailabilityZone

setAvailabilityZone

withAvailabilityZone

getState

setState

withState

setState

withState

getCreateTime

setCreateTime

withCreateTime

getAttachments

setAttachments

withAttachments

withAttachments

getTags

setTags

withTags

withTags

getVolumeType

setVolumeType

withVolumeType

setVolumeType

withVolumeType

getIops

setIops

withIops

toString

hashCode

equals