Class AdministrativeAction

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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<AdministrativeAction.Builder,AdministrativeAction>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.