Volume (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Describes an Amazon FSx volume.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Volume()

Constructors
Constructor and Description
`Volume()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Volume`	`clone()`
`boolean`	`equals(Object obj)`
`List<AdministrativeAction>`	`getAdministrativeActions()` A list of administrative actions for the volume that are in process or waiting to be processed.
`Date`	`getCreationTime()`
`String`	`getFileSystemId()`
`String`	`getLifecycle()` The lifecycle status of the volume.
`LifecycleTransitionReason`	`getLifecycleTransitionReason()` The reason why the volume lifecycle status changed.
`String`	`getName()` The name of the volume.
`OntapVolumeConfiguration`	`getOntapConfiguration()`
`OpenZFSVolumeConfiguration`	`getOpenZFSConfiguration()` The configuration of an Amazon FSx for OpenZFS volume.
`String`	`getResourceARN()`
`List<Tag>`	`getTags()`
`String`	`getVolumeId()` The system-generated, unique ID of the volume.
`String`	`getVolumeType()` The type of the volume.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdministrativeActions(Collection<AdministrativeAction> administrativeActions)` A list of administrative actions for the volume that are in process or waiting to be processed.
`void`	`setCreationTime(Date creationTime)`
`void`	`setFileSystemId(String fileSystemId)`
`void`	`setLifecycle(String lifecycle)` The lifecycle status of the volume.
`void`	`setLifecycleTransitionReason(LifecycleTransitionReason lifecycleTransitionReason)` The reason why the volume lifecycle status changed.
`void`	`setName(String name)` The name of the volume.
`void`	`setOntapConfiguration(OntapVolumeConfiguration ontapConfiguration)`
`void`	`setOpenZFSConfiguration(OpenZFSVolumeConfiguration openZFSConfiguration)` The configuration of an Amazon FSx for OpenZFS volume.
`void`	`setResourceARN(String resourceARN)`
`void`	`setTags(Collection<Tag> tags)`
`void`	`setVolumeId(String volumeId)` The system-generated, unique ID of the volume.
`void`	`setVolumeType(String volumeType)` The type of the volume.
`String`	`toString()` Returns a string representation of this object.
`Volume`	`withAdministrativeActions(AdministrativeAction... administrativeActions)` A list of administrative actions for the volume that are in process or waiting to be processed.
`Volume`	`withAdministrativeActions(Collection<AdministrativeAction> administrativeActions)` A list of administrative actions for the volume that are in process or waiting to be processed.
`Volume`	`withCreationTime(Date creationTime)`
`Volume`	`withFileSystemId(String fileSystemId)`
`Volume`	`withLifecycle(String lifecycle)` The lifecycle status of the volume.
`Volume`	`withLifecycle(VolumeLifecycle lifecycle)` The lifecycle status of the volume.
`Volume`	`withLifecycleTransitionReason(LifecycleTransitionReason lifecycleTransitionReason)` The reason why the volume lifecycle status changed.
`Volume`	`withName(String name)` The name of the volume.
`Volume`	`withOntapConfiguration(OntapVolumeConfiguration ontapConfiguration)`
`Volume`	`withOpenZFSConfiguration(OpenZFSVolumeConfiguration openZFSConfiguration)` The configuration of an Amazon FSx for OpenZFS volume.
`Volume`	`withResourceARN(String resourceARN)`
`Volume`	`withTags(Collection<Tag> tags)`
`Volume`	`withTags(Tag... tags)` NOTE: This method appends the values to the existing list (if any).
`Volume`	`withVolumeId(String volumeId)` The system-generated, unique ID of the volume.
`Volume`	`withVolumeType(String volumeType)` The type of the volume.
`Volume`	`withVolumeType(VolumeType volumeType)` The type of the volume.

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

- Constructor Detail
  - Volume
```
public Volume()
```
- Method Detail
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    Parameters:
    
    creationTime -
  - getCreationTime
```
public Date getCreationTime()
```
    Returns:
  - withCreationTime
```
public Volume withCreationTime(Date creationTime)
```
    Parameters:
    
    creationTime -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFileSystemId
```
public void setFileSystemId(String fileSystemId)
```
    Parameters:
    
    fileSystemId -
  - getFileSystemId
```
public String getFileSystemId()
```
    Returns:
  - withFileSystemId
```
public Volume withFileSystemId(String fileSystemId)
```
    Parameters:
    
    fileSystemId -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLifecycle
```
public void setLifecycle(String lifecycle)
```
    The lifecycle status of the volume.
    - AVAILABLE - The volume is fully available for use.
    - CREATED - The volume has been created.
    - CREATING - Amazon FSx is creating the new volume.
    - DELETING - Amazon FSx is deleting an existing volume.
    - FAILED - Amazon FSx was unable to create the volume.
    - MISCONFIGURED - The volume is in a failed but recoverable state.
    - PENDING - Amazon FSx hasn't started creating the volume.
    Parameters:
    lifecycle - The lifecycle status of the volume.
    
    AVAILABLE - The volume is fully available for use.
    
    CREATED - The volume has been created.
    
    CREATING - Amazon FSx is creating the new volume.
    
    DELETING - Amazon FSx is deleting an existing volume.
    
    FAILED - Amazon FSx was unable to create the volume.
    
    MISCONFIGURED - The volume is in a failed but recoverable state.
    
    PENDING - Amazon FSx hasn't started creating the volume.
    See Also:
    
    VolumeLifecycle
  - getLifecycle
```
public String getLifecycle()
```
    The lifecycle status of the volume.
    - AVAILABLE - The volume is fully available for use.
    - CREATED - The volume has been created.
    - CREATING - Amazon FSx is creating the new volume.
    - DELETING - Amazon FSx is deleting an existing volume.
    - FAILED - Amazon FSx was unable to create the volume.
    - MISCONFIGURED - The volume is in a failed but recoverable state.
    - PENDING - Amazon FSx hasn't started creating the volume.
    Returns:
    The lifecycle status of the volume.
    
    AVAILABLE - The volume is fully available for use.
    
    CREATED - The volume has been created.
    
    CREATING - Amazon FSx is creating the new volume.
    
    DELETING - Amazon FSx is deleting an existing volume.
    
    FAILED - Amazon FSx was unable to create the volume.
    
    MISCONFIGURED - The volume is in a failed but recoverable state.
    
    PENDING - Amazon FSx hasn't started creating the volume.
    See Also:
    
    VolumeLifecycle
  - withLifecycle
```
public Volume withLifecycle(String lifecycle)
```
    The lifecycle status of the volume.
    - AVAILABLE - The volume is fully available for use.
    - CREATED - The volume has been created.
    - CREATING - Amazon FSx is creating the new volume.
    - DELETING - Amazon FSx is deleting an existing volume.
    - FAILED - Amazon FSx was unable to create the volume.
    - MISCONFIGURED - The volume is in a failed but recoverable state.
    - PENDING - Amazon FSx hasn't started creating the volume.
    Parameters:
    lifecycle - The lifecycle status of the volume.
    
    AVAILABLE - The volume is fully available for use.
    
    CREATED - The volume has been created.
    
    CREATING - Amazon FSx is creating the new volume.
    
    DELETING - Amazon FSx is deleting an existing volume.
    
    FAILED - Amazon FSx was unable to create the volume.
    
    MISCONFIGURED - The volume is in a failed but recoverable state.
    
    PENDING - Amazon FSx hasn't started creating the volume.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeLifecycle
  - withLifecycle
```
public Volume withLifecycle(VolumeLifecycle lifecycle)
```
    The lifecycle status of the volume.
    - AVAILABLE - The volume is fully available for use.
    - CREATED - The volume has been created.
    - CREATING - Amazon FSx is creating the new volume.
    - DELETING - Amazon FSx is deleting an existing volume.
    - FAILED - Amazon FSx was unable to create the volume.
    - MISCONFIGURED - The volume is in a failed but recoverable state.
    - PENDING - Amazon FSx hasn't started creating the volume.
    Parameters:
    lifecycle - The lifecycle status of the volume.
    
    AVAILABLE - The volume is fully available for use.
    
    CREATED - The volume has been created.
    
    CREATING - Amazon FSx is creating the new volume.
    
    DELETING - Amazon FSx is deleting an existing volume.
    
    FAILED - Amazon FSx was unable to create the volume.
    
    MISCONFIGURED - The volume is in a failed but recoverable state.
    
    PENDING - Amazon FSx hasn't started creating the volume.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeLifecycle
  - setName
```
public void setName(String name)
```
    The name of the volume.
    
    Parameters:
    
    name - The name of the volume.
  - getName
```
public String getName()
```
    The name of the volume.
    
    Returns:
    
    The name of the volume.
  - withName
```
public Volume withName(String name)
```
    The name of the volume.
    
    Parameters:
    
    name - The name of the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOntapConfiguration
```
public void setOntapConfiguration(OntapVolumeConfiguration ontapConfiguration)
```
    Parameters:
    
    ontapConfiguration -
  - getOntapConfiguration
```
public OntapVolumeConfiguration getOntapConfiguration()
```
    Returns:
  - withOntapConfiguration
```
public Volume withOntapConfiguration(OntapVolumeConfiguration ontapConfiguration)
```
    Parameters:
    
    ontapConfiguration -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceARN
```
public void setResourceARN(String resourceARN)
```
    Parameters:
    
    resourceARN -
  - getResourceARN
```
public String getResourceARN()
```
    Returns:
  - withResourceARN
```
public Volume withResourceARN(String resourceARN)
```
    Parameters:
    
    resourceARN -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Returns:
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Parameters:
    
    tags -
  - withTags
```
public Volume withTags(Tag... tags)
```
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public Volume withTags(Collection<Tag> tags)
```
    Parameters:
    
    tags -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeId
```
public void setVolumeId(String volumeId)
```
    The system-generated, unique ID of the volume.
    
    Parameters:
    
    volumeId - The system-generated, unique ID of the volume.
  - getVolumeId
```
public String getVolumeId()
```
    The system-generated, unique ID of the volume.
    
    Returns:
    
    The system-generated, unique ID of the volume.
  - withVolumeId
```
public Volume withVolumeId(String volumeId)
```
    The system-generated, unique ID of the volume.
    
    Parameters:
    
    volumeId - The system-generated, unique ID of the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeType
```
public void setVolumeType(String volumeType)
```
    The type of the volume.
    
    Parameters:
    
    volumeType - The type of the volume.
    
    See Also:
    
    VolumeType
  - getVolumeType
```
public String getVolumeType()
```
    The type of the volume.
    
    Returns:
    
    The type of the volume.
    
    See Also:
    
    VolumeType
  - withVolumeType
```
public Volume withVolumeType(String volumeType)
```
    The type of the volume.
    
    Parameters:
    
    volumeType - The type of the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeType
  - withVolumeType
```
public Volume withVolumeType(VolumeType volumeType)
```
    The type of the volume.
    
    Parameters:
    
    volumeType - The type of the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeType
  - setLifecycleTransitionReason
```
public void setLifecycleTransitionReason(LifecycleTransitionReason lifecycleTransitionReason)
```
    The reason why the volume lifecycle status changed.
    
    Parameters:
    
    lifecycleTransitionReason - The reason why the volume lifecycle status changed.
  - getLifecycleTransitionReason
```
public LifecycleTransitionReason getLifecycleTransitionReason()
```
    The reason why the volume lifecycle status changed.
    
    Returns:
    
    The reason why the volume lifecycle status changed.
  - withLifecycleTransitionReason
```
public Volume withLifecycleTransitionReason(LifecycleTransitionReason lifecycleTransitionReason)
```
    The reason why the volume lifecycle status changed.
    
    Parameters:
    
    lifecycleTransitionReason - The reason why the volume lifecycle status changed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdministrativeActions
```
public List<AdministrativeAction> getAdministrativeActions()
```
    A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.
    
    Returns:
    
    A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.
  - setAdministrativeActions
```
public void setAdministrativeActions(Collection<AdministrativeAction> administrativeActions)
```
    A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.
    
    Parameters:
    
    administrativeActions - A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.
  - withAdministrativeActions
```
public Volume withAdministrativeActions(AdministrativeAction... administrativeActions)
```
    A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdministrativeActions(java.util.Collection) or withAdministrativeActions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    administrativeActions - A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdministrativeActions
```
public Volume withAdministrativeActions(Collection<AdministrativeAction> administrativeActions)
```
    A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.
    
    Parameters:
    
    administrativeActions - A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOpenZFSConfiguration
```
public void setOpenZFSConfiguration(OpenZFSVolumeConfiguration openZFSConfiguration)
```
    The configuration of an Amazon FSx for OpenZFS volume.
    
    Parameters:
    
    openZFSConfiguration - The configuration of an Amazon FSx for OpenZFS volume.
  - getOpenZFSConfiguration
```
public OpenZFSVolumeConfiguration getOpenZFSConfiguration()
```
    The configuration of an Amazon FSx for OpenZFS volume.
    
    Returns:
    
    The configuration of an Amazon FSx for OpenZFS volume.
  - withOpenZFSConfiguration
```
public Volume withOpenZFSConfiguration(OpenZFSVolumeConfiguration openZFSConfiguration)
```
    The configuration of an Amazon FSx for OpenZFS volume.
    
    Parameters:
    
    openZFSConfiguration - The configuration of an Amazon FSx for OpenZFS volume.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 Volume 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.

AWS SDK for Java 1.x API Reference - 1.12.778

Class Volume

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Volume

Method Detail

setCreationTime

getCreationTime

withCreationTime

setFileSystemId

getFileSystemId

withFileSystemId

setLifecycle

getLifecycle

withLifecycle

withLifecycle

setName

getName

withName

setOntapConfiguration

getOntapConfiguration

withOntapConfiguration

setResourceARN

getResourceARN

withResourceARN

getTags

setTags

withTags

withTags

setVolumeId

getVolumeId

withVolumeId

setVolumeType

getVolumeType

withVolumeType

withVolumeType

setLifecycleTransitionReason

getLifecycleTransitionReason

withLifecycleTransitionReason

getAdministrativeActions

setAdministrativeActions

withAdministrativeActions

withAdministrativeActions

setOpenZFSConfiguration

getOpenZFSConfiguration

withOpenZFSConfiguration

toString

equals

hashCode

clone

marshall