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 or Lustre file system.

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()` Provides the percent complete of a `STORAGE_OPTIMIZATION` administrative action.
`Date`	`getRequestTime()` Time that the administrative action request was received.
`String`	`getStatus()` Describes the status of the administrative action, as follows:
`FileSystem`	`getTargetFileSystemValues()` Describes the target value for the administration action, provided in the `UpdateFileSystem` operation.
`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)` Provides the percent complete of a `STORAGE_OPTIMIZATION` administrative action.
`void`	`setRequestTime(Date requestTime)` Time that the administrative action request was received.
`void`	`setStatus(String status)` Describes the status of the administrative action, as follows:
`void`	`setTargetFileSystemValues(FileSystem targetFileSystemValues)` Describes the target value for the administration action, provided in the `UpdateFileSystem` operation.
`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)` Provides the percent complete of a `STORAGE_OPTIMIZATION` administrative action.
`AdministrativeAction`	`withRequestTime(Date requestTime)` Time that the administrative action request was received.
`AdministrativeAction`	`withStatus(Status status)` Describes the status of the administrative action, as follows:
`AdministrativeAction`	`withStatus(String status)` Describes the status of the administrative action, as follows:
`AdministrativeAction`	`withTargetFileSystemValues(FileSystem targetFileSystemValues)` Describes the target value for the administration action, provided in the `UpdateFileSystem` operation.

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)
```
    Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
    
    Parameters:
    
    progressPercent - Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
  - getProgressPercent
```
public Integer getProgressPercent()
```
    Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
    
    Returns:
    
    Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
  - withProgressPercent
```
public AdministrativeAction withProgressPercent(Integer progressPercent)
```
    Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
    
    Parameters:
    
    progressPercent - Provides the percent complete of a STORAGE_OPTIMIZATION 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)
```
    Time that the administrative action request was received.
    
    Parameters:
    
    requestTime - Time that the administrative action request was received.
  - getRequestTime
```
public Date getRequestTime()
```
    Time that the administrative action request was received.
    
    Returns:
    
    Time that the administrative action request was received.
  - withRequestTime
```
public AdministrativeAction withRequestTime(Date requestTime)
```
    Time that the administrative action request was received.
    
    Parameters:
    
    requestTime - 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)
```
    Describes 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.
    - 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. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.
    Parameters:
    status - Describes 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.
    
    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. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.
    See Also:
    
    Status
  - getStatus
```
public String getStatus()
```
    Describes 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.
    - 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. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.
    Returns:
    Describes 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.
    
    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. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.
    See Also:
    
    Status
  - withStatus
```
public AdministrativeAction withStatus(String status)
```
    Describes 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.
    - 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. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.
    Parameters:
    status - Describes 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.
    
    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. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - withStatus
```
public AdministrativeAction withStatus(Status status)
```
    Describes 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.
    - 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. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.
    Parameters:
    status - Describes 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.
    
    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. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - setTargetFileSystemValues
```
public void setTargetFileSystemValues(FileSystem targetFileSystemValues)
```
    Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
    
    Parameters:
    
    targetFileSystemValues - Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
  - getTargetFileSystemValues
```
public FileSystem getTargetFileSystemValues()
```
    Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
    
    Returns:
    
    Describes 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)
```
    Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
    
    Parameters:
    
    targetFileSystemValues - Describes 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.
  - 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.

Did this page help you?

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

toString

equals

hashCode

clone

marshall