Package software.amazon.awssdk.services.fsx.model

Interface AdministrativeAction.Builder

    • Method Detail

      • administrativeActionType

        AdministrativeAction.Builder administrativeActionType​(String administrativeActionType)
        Sets the value of the AdministrativeActionType property for this object.
        Parameters:
        administrativeActionType - The new value for the AdministrativeActionType property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AdministrativeActionType, AdministrativeActionType

      • progressPercent

        AdministrativeAction.Builder progressPercent​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • requestTime

        AdministrativeAction.Builder requestTime​(Instant requestTime)

        The time that the administrative action request was received.

        Parameters:
        requestTime - The time that the administrative action request was received.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        AdministrativeAction.Builder status​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Status, Status

      • status

        AdministrativeAction.Builder status​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Status, Status

      • targetFileSystemValues

        AdministrativeAction.Builder targetFileSystemValues​(FileSystem targetFileSystemValues)

        The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

        Parameters:
        targetFileSystemValues - The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureDetails

        AdministrativeAction.Builder failureDetails​(AdministrativeActionFailureDetails failureDetails)
        Sets the value of the FailureDetails property for this object.
        Parameters:
        failureDetails - The new value for the FailureDetails property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetVolumeValues

        AdministrativeAction.Builder targetVolumeValues​(Volume targetVolumeValues)
        Sets the value of the TargetVolumeValues property for this object.
        Parameters:
        targetVolumeValues - The new value for the TargetVolumeValues property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetSnapshotValues

        AdministrativeAction.Builder targetSnapshotValues​(Snapshot targetSnapshotValues)
        Sets the value of the TargetSnapshotValues property for this object.
        Parameters:
        targetSnapshotValues - The new value for the TargetSnapshotValues property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • totalTransferBytes

        AdministrativeAction.Builder totalTransferBytes​(Long totalTransferBytes)

        The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.

        Parameters:
        totalTransferBytes - The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • remainingTransferBytes

        AdministrativeAction.Builder remainingTransferBytes​(Long remainingTransferBytes)

        The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.

        Parameters:
        remainingTransferBytes - The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.
        Returns:
        Returns a reference to this object so that method calls can be chained together.