AdministrativeAction (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.fsx.model.AdministrativeAction

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AdministrativeAction
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AdministrativeAction()

Constructors
Constructor and Description
`AdministrativeAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdministrativeAction`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAdministrativeActionType()`
`AdministrativeActionFailureDetails`	`getFailureDetails()`
`Integer`	`getProgressPercent()` The percentage-complete status of a `STORAGE_OPTIMIZATION` or `DOWNLOAD_DATA_FROM_BACKUP` administrative action.
`Long`	`getRemainingTransferBytes()` The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.
`Date`	`getRequestTime()` The time that the administrative action request was received.
`String`	`getStatus()` The status of the administrative action, as follows:
`FileSystem`	`getTargetFileSystemValues()` The target value for the administration action, provided in the `UpdateFileSystem` operation.
`Snapshot`	`getTargetSnapshotValues()`
`Volume`	`getTargetVolumeValues()`
`Long`	`getTotalTransferBytes()` The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdministrativeActionType(String administrativeActionType)`
`void`	`setFailureDetails(AdministrativeActionFailureDetails failureDetails)`
`void`	`setProgressPercent(Integer progressPercent)` The percentage-complete status of a `STORAGE_OPTIMIZATION` or `DOWNLOAD_DATA_FROM_BACKUP` administrative action.
`void`	`setRemainingTransferBytes(Long remainingTransferBytes)` The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.
`void`	`setRequestTime(Date requestTime)` The time that the administrative action request was received.
`void`	`setStatus(String status)` The status of the administrative action, as follows:
`void`	`setTargetFileSystemValues(FileSystem targetFileSystemValues)` The target value for the administration action, provided in the `UpdateFileSystem` operation.
`void`	`setTargetSnapshotValues(Snapshot targetSnapshotValues)`
`void`	`setTargetVolumeValues(Volume targetVolumeValues)`
`void`	`setTotalTransferBytes(Long totalTransferBytes)` The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.
`String`	`toString()` Returns a string representation of this object.
`AdministrativeAction`	`withAdministrativeActionType(AdministrativeActionType administrativeActionType)`
`AdministrativeAction`	`withAdministrativeActionType(String administrativeActionType)`
`AdministrativeAction`	`withFailureDetails(AdministrativeActionFailureDetails failureDetails)`
`AdministrativeAction`	`withProgressPercent(Integer progressPercent)` The percentage-complete status of a `STORAGE_OPTIMIZATION` or `DOWNLOAD_DATA_FROM_BACKUP` administrative action.
`AdministrativeAction`	`withRemainingTransferBytes(Long remainingTransferBytes)` The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.
`AdministrativeAction`	`withRequestTime(Date requestTime)` The time that the administrative action request was received.
`AdministrativeAction`	`withStatus(Status status)` The status of the administrative action, as follows:
`AdministrativeAction`	`withStatus(String status)` The status of the administrative action, as follows:
`AdministrativeAction`	`withTargetFileSystemValues(FileSystem targetFileSystemValues)` The target value for the administration action, provided in the `UpdateFileSystem` operation.
`AdministrativeAction`	`withTargetSnapshotValues(Snapshot targetSnapshotValues)`
`AdministrativeAction`	`withTargetVolumeValues(Volume targetVolumeValues)`
`AdministrativeAction`	`withTotalTransferBytes(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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AdministrativeAction
```
public AdministrativeAction()
```
- Method Detail
  - setAdministrativeActionType
```
public void setAdministrativeActionType(String administrativeActionType)
```
    Parameters:
    
    administrativeActionType -
    
    See Also:
    
    AdministrativeActionType
  - getAdministrativeActionType
```
public String getAdministrativeActionType()
```
    Returns:
    
    See Also:
    
    AdministrativeActionType
  - withAdministrativeActionType
```
public AdministrativeAction withAdministrativeActionType(String administrativeActionType)
```
    Parameters:
    
    administrativeActionType -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AdministrativeActionType
  - withAdministrativeActionType
```
public AdministrativeAction withAdministrativeActionType(AdministrativeActionType administrativeActionType)
```
    Parameters:
    
    administrativeActionType -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AdministrativeActionType
  - setProgressPercent
```
public void setProgressPercent(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.
  - getProgressPercent
```
public Integer getProgressPercent()
```
    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.
  - withProgressPercent
```
public AdministrativeAction withProgressPercent(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.
  - setRequestTime
```
public void setRequestTime(Date requestTime)
```
    The time that the administrative action request was received.
    
    Parameters:
    
    requestTime - The time that the administrative action request was received.
  - getRequestTime
```
public Date getRequestTime()
```
    The time that the administrative action request was received.
    
    Returns:
    
    The time that the administrative action request was received.
  - withRequestTime
```
public AdministrativeAction withRequestTime(Date 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.
  - setStatus
```
public void setStatus(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.
    See Also:
    
    Status
  - getStatus
```
public String getStatus()
```
    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:
    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
  - withStatus
```
public AdministrativeAction withStatus(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
  - withStatus
```
public AdministrativeAction withStatus(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
  - setTargetFileSystemValues
```
public void setTargetFileSystemValues(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.
  - getTargetFileSystemValues
```
public FileSystem getTargetFileSystemValues()
```
    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.
  - withTargetFileSystemValues
```
public AdministrativeAction withTargetFileSystemValues(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.
  - setFailureDetails
```
public void setFailureDetails(AdministrativeActionFailureDetails failureDetails)
```
    Parameters:
    
    failureDetails -
  - getFailureDetails
```
public AdministrativeActionFailureDetails getFailureDetails()
```
    Returns:
  - withFailureDetails
```
public AdministrativeAction withFailureDetails(AdministrativeActionFailureDetails failureDetails)
```
    Parameters:
    
    failureDetails -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetVolumeValues
```
public void setTargetVolumeValues(Volume targetVolumeValues)
```
    Parameters:
    
    targetVolumeValues -
  - getTargetVolumeValues
```
public Volume getTargetVolumeValues()
```
    Returns:
  - withTargetVolumeValues
```
public AdministrativeAction withTargetVolumeValues(Volume targetVolumeValues)
```
    Parameters:
    
    targetVolumeValues -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetSnapshotValues
```
public void setTargetSnapshotValues(Snapshot targetSnapshotValues)
```
    Parameters:
    
    targetSnapshotValues -
  - getTargetSnapshotValues
```
public Snapshot getTargetSnapshotValues()
```
    Returns:
  - withTargetSnapshotValues
```
public AdministrativeAction withTargetSnapshotValues(Snapshot targetSnapshotValues)
```
    Parameters:
    
    targetSnapshotValues -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalTransferBytes
```
public void setTotalTransferBytes(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.
  - getTotalTransferBytes
```
public Long getTotalTransferBytes()
```
    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.
  - withTotalTransferBytes
```
public AdministrativeAction withTotalTransferBytes(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.
  - setRemainingTransferBytes
```
public void setRemainingTransferBytes(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.
  - getRemainingTransferBytes
```
public Long getRemainingTransferBytes()
```
    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.
  - withRemainingTransferBytes
```
public AdministrativeAction withRemainingTransferBytes(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AdministrativeAction clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class AdministrativeAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AdministrativeAction

Method Detail

setAdministrativeActionType

getAdministrativeActionType

withAdministrativeActionType

withAdministrativeActionType

setProgressPercent

getProgressPercent

withProgressPercent

setRequestTime

getRequestTime

withRequestTime

setStatus

getStatus

withStatus

withStatus

setTargetFileSystemValues

getTargetFileSystemValues

withTargetFileSystemValues

setFailureDetails

getFailureDetails

withFailureDetails

setTargetVolumeValues

getTargetVolumeValues

withTargetVolumeValues

setTargetSnapshotValues

getTargetSnapshotValues

withTargetSnapshotValues

setTotalTransferBytes

getTotalTransferBytes

withTotalTransferBytes

setRemainingTransferBytes

getRemainingTransferBytes

withRemainingTransferBytes

toString

equals

hashCode

clone

marshall