Volume (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.fsx.model.Volume

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Volume.Builder,Volume>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Volume
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Volume.Builder,Volume>
```
Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Volume.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Volume.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AdministrativeAction>`	`administrativeActions()` A list of administrative actions for the volume that are in process or waiting to be processed.
`static Volume.Builder`	`builder()`
`Instant`	`creationTime()` Returns the value of the CreationTime property for this object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`fileSystemId()` Returns the value of the FileSystemId property for this object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdministrativeActions()` For responses, this returns true if the service returned a value for the AdministrativeActions property.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`VolumeLifecycle`	`lifecycle()` The lifecycle status of the volume.
`String`	`lifecycleAsString()` The lifecycle status of the volume.
`LifecycleTransitionReason`	`lifecycleTransitionReason()` The reason why the volume lifecycle status changed.
`String`	`name()` The name of the volume.
`OntapVolumeConfiguration`	`ontapConfiguration()` Returns the value of the OntapConfiguration property for this object.
`OpenZFSVolumeConfiguration`	`openZFSConfiguration()` The configuration of an Amazon FSx for OpenZFS volume.
`String`	`resourceARN()` Returns the value of the ResourceARN property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Volume.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` Returns the value of the Tags property for this object.
`Volume.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`volumeId()` The system-generated, unique ID of the volume.
`VolumeType`	`volumeType()` The type of the volume.
`String`	`volumeTypeAsString()` The type of the volume.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - creationTime
```
public final Instant creationTime()
```
    Returns the value of the CreationTime property for this object.
    
    Returns:
    
    The value of the CreationTime property for this object.
  - fileSystemId
```
public final String fileSystemId()
```
    Returns the value of the FileSystemId property for this object.
    
    Returns:
    
    The value of the FileSystemId property for this object.
  - lifecycle
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, lifecycle will return VolumeLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().
    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
  - lifecycleAsString
```
public final String lifecycleAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, lifecycle will return VolumeLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().
    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
  - name
```
public final String name()
```
    The name of the volume.
    
    Returns:
    
    The name of the volume.
  - ontapConfiguration
```
public final OntapVolumeConfiguration ontapConfiguration()
```
    Returns the value of the OntapConfiguration property for this object.
    
    Returns:
    
    The value of the OntapConfiguration property for this object.
  - resourceARN
```
public final String resourceARN()
```
    Returns the value of the ResourceARN property for this object.
    
    Returns:
    
    The value of the ResourceARN property for this object.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    Returns the value of the Tags property for this object.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The value of the Tags property for this object.
  - volumeId
```
public final String volumeId()
```
    The system-generated, unique ID of the volume.
    
    Returns:
    
    The system-generated, unique ID of the volume.
  - volumeType
```
public final VolumeType volumeType()
```
    The type of the volume.
    
    If the service returns an enum value that is not available in the current SDK version, volumeType will return VolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from volumeTypeAsString().
    
    Returns:
    
    The type of the volume.
    
    See Also:
    
    VolumeType
  - volumeTypeAsString
```
public final String volumeTypeAsString()
```
    The type of the volume.
    
    If the service returns an enum value that is not available in the current SDK version, volumeType will return VolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from volumeTypeAsString().
    
    Returns:
    
    The type of the volume.
    
    See Also:
    
    VolumeType
  - lifecycleTransitionReason
```
public final LifecycleTransitionReason lifecycleTransitionReason()
```
    The reason why the volume lifecycle status changed.
    
    Returns:
    
    The reason why the volume lifecycle status changed.
  - hasAdministrativeActions
```
public final boolean hasAdministrativeActions()
```
    For responses, this returns true if the service returned a value for the AdministrativeActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - administrativeActions
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdministrativeActions() method.
    
    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.
  - openZFSConfiguration
```
public final OpenZFSVolumeConfiguration openZFSConfiguration()
```
    The configuration of an Amazon FSx for OpenZFS volume.
    
    Returns:
    
    The configuration of an Amazon FSx for OpenZFS volume.
  - toBuilder
```
public Volume.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Volume.Builder,Volume>
  - builder
```
public static Volume.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Volume.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Volume

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

creationTime

fileSystemId

lifecycle

lifecycleAsString

name

ontapConfiguration

resourceARN

hasTags

tags

volumeId

volumeType

volumeTypeAsString

lifecycleTransitionReason

hasAdministrativeActions

administrativeActions

openZFSConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields