Class Volume
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Volume.Builder,
Volume>
Describes an Amazon FSx volume.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AdministrativeAction> A list of administrative actions for the volume that are in process or waiting to be processed.static Volume.Builder
builder()
final Instant
Returns the value of the CreationTime property for this object.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Returns the value of the FileSystemId property for this object.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AdministrativeActions property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final VolumeLifecycle
The lifecycle status of the volume.final String
The lifecycle status of the volume.The reason why the volume lifecycle status changed.final String
name()
The name of the volume.final OntapVolumeConfiguration
Returns the value of the OntapConfiguration property for this object.The configuration of an Amazon FSx for OpenZFS volume.final String
Returns the value of the ResourceARN property for this object.static Class
<? extends Volume.Builder> tags()
Returns the value of the Tags property for this object.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
volumeId()
The system-generated, unique ID of the volume.final VolumeType
The type of the volume.final String
The type of the volume.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
creationTime
Returns the value of the CreationTime property for this object.- Returns:
- The value of the CreationTime property for this object.
-
fileSystemId
Returns the value of the FileSystemId property for this object.- Returns:
- The value of the FileSystemId property for this object.
-
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 returnVolumeLifecycle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifecycleAsString()
.- 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:
-
-
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 returnVolumeLifecycle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifecycleAsString()
.- 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:
-
-
name
The name of the volume.
- Returns:
- The name of the volume.
-
ontapConfiguration
Returns the value of the OntapConfiguration property for this object.- Returns:
- The value of the OntapConfiguration property for this object.
-
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 theisEmpty()
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
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
The system-generated, unique ID of the volume.
- Returns:
- The system-generated, unique ID of the volume.
-
volumeType
The type of the volume.
If the service returns an enum value that is not available in the current SDK version,
volumeType
will returnVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeTypeAsString()
.- Returns:
- The type of the volume.
- See Also:
-
volumeTypeAsString
The type of the volume.
If the service returns an enum value that is not available in the current SDK version,
volumeType
will returnVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeTypeAsString()
.- Returns:
- The type of the volume.
- See Also:
-
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 theisEmpty()
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
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
The configuration of an Amazon FSx for OpenZFS volume.
- Returns:
- The configuration of an Amazon FSx for OpenZFS volume.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Volume.Builder,
Volume> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-