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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AdministrativeAction.Builder,AdministrativeAction>
```
@Generated("software.amazon.awssdk:codegen")
public final class AdministrativeAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AdministrativeAction.Builder,AdministrativeAction>
```
Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AdministrativeAction.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AdministrativeActionType`	`administrativeActionType()`	Returns the value of the AdministrativeActionType property for this object.
`String`	`administrativeActionTypeAsString()`	Returns the value of the AdministrativeActionType property for this object.
`static AdministrativeAction.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`AdministrativeActionFailureDetails`	`failureDetails()`	Returns the value of the FailureDetails property for this object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`progressPercent()`	The percentage-complete status of a `STORAGE_OPTIMIZATION` or `DOWNLOAD_DATA_FROM_BACKUP` administrative action.
`Long`	`remainingTransferBytes()`	The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.
`Instant`	`requestTime()`	The time that the administrative action request was received.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AdministrativeAction.Builder>`	`serializableBuilderClass()`
`Status`	`status()`	The status of the administrative action, as follows:
`String`	`statusAsString()`	The status of the administrative action, as follows:
`FileSystem`	`targetFileSystemValues()`	The target value for the administration action, provided in the `UpdateFileSystem` operation.
`Snapshot`	`targetSnapshotValues()`	Returns the value of the TargetSnapshotValues property for this object.
`Volume`	`targetVolumeValues()`	Returns the value of the TargetVolumeValues property for this object.
`AdministrativeAction.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Long`	`totalTransferBytes()`	The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.

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
  - administrativeActionType
```
public final AdministrativeActionType administrativeActionType()
```
    Returns the value of the AdministrativeActionType property for this object.
    If the service returns an enum value that is not available in the current SDK version, administrativeActionType will return AdministrativeActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from administrativeActionTypeAsString().
    
    Returns:
    
    The value of the AdministrativeActionType property for this object.
    
    See Also:
    
    AdministrativeActionType
  - administrativeActionTypeAsString
```
public final String administrativeActionTypeAsString()
```
    Returns the value of the AdministrativeActionType property for this object.
    If the service returns an enum value that is not available in the current SDK version, administrativeActionType will return AdministrativeActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from administrativeActionTypeAsString().
    
    Returns:
    
    The value of the AdministrativeActionType property for this object.
    
    See Also:
    
    AdministrativeActionType
  - progressPercent
```
public final Integer progressPercent()
```
    The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.
    
    Returns:
    
    The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.
  - requestTime
```
public final Instant requestTime()
```
    The time that the administrative action request was received.
    
    Returns:
    
    The time that the administrative action request was received.
  - status
```
public final Status status()
```
    The status of the administrative action, as follows:
    
    FAILED - Amazon FSx failed to process the administrative action successfully.
    
    IN_PROGRESS - Amazon FSx is processing the administrative action.
    
    PENDING - Amazon FSx is waiting to process the administrative action.
    
    COMPLETED - Amazon FSx has finished processing the administrative task.
    
    For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.
    
    UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.
    
    PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.
    
    IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.
    
    If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    The status of the administrative action, as follows:
    
    FAILED - Amazon FSx failed to process the administrative action successfully.
    
    IN_PROGRESS - Amazon FSx is processing the administrative action.
    
    PENDING - Amazon FSx is waiting to process the administrative action.
    
    COMPLETED - Amazon FSx has finished processing the administrative task.
    
    For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.
    
    UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.
    
    PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.
    
    IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.
    
    See Also:
    
    Status
  - statusAsString
```
public final String statusAsString()
```
    The status of the administrative action, as follows:
    
    FAILED - Amazon FSx failed to process the administrative action successfully.
    
    IN_PROGRESS - Amazon FSx is processing the administrative action.
    
    PENDING - Amazon FSx is waiting to process the administrative action.
    
    COMPLETED - Amazon FSx has finished processing the administrative task.
    
    For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.
    
    UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.
    
    PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.
    
    IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.
    
    If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    The status of the administrative action, as follows:
    
    FAILED - Amazon FSx failed to process the administrative action successfully.
    
    IN_PROGRESS - Amazon FSx is processing the administrative action.
    
    PENDING - Amazon FSx is waiting to process the administrative action.
    
    COMPLETED - Amazon FSx has finished processing the administrative task.
    
    For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.
    
    UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.
    
    PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.
    
    IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.
    
    See Also:
    
    Status
  - targetFileSystemValues
```
public final FileSystem targetFileSystemValues()
```
    The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
    
    Returns:
    
    The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
  - failureDetails
```
public final AdministrativeActionFailureDetails failureDetails()
```
    Returns the value of the FailureDetails property for this object.
    
    Returns:
    
    The value of the FailureDetails property for this object.
  - targetVolumeValues
```
public final Volume targetVolumeValues()
```
    Returns the value of the TargetVolumeValues property for this object.
    
    Returns:
    
    The value of the TargetVolumeValues property for this object.
  - targetSnapshotValues
```
public final Snapshot targetSnapshotValues()
```
    Returns the value of the TargetSnapshotValues property for this object.
    
    Returns:
    
    The value of the TargetSnapshotValues property for this object.
  - totalTransferBytes
```
public final Long totalTransferBytes()
```
    The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.
    
    Returns:
    
    The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.
  - remainingTransferBytes
```
public final Long remainingTransferBytes()
```
    The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.
    
    Returns:
    
    The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.
  - toBuilder
```
public AdministrativeAction.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AdministrativeAction.Builder,AdministrativeAction>
  - builder
```
public static AdministrativeAction.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AdministrativeAction.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class AdministrativeAction

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

administrativeActionType

administrativeActionTypeAsString

progressPercent

requestTime

status

statusAsString

targetFileSystemValues

failureDetails

targetVolumeValues

targetSnapshotValues

totalTransferBytes

remainingTransferBytes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField