software.amazon.awssdk.services.fsx.model

Class AdministrativeAction

java.lang.Object

software.amazon.awssdk.services.fsx.model.AdministrativeAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AdministrativeAction.Builder,AdministrativeAction>

@Generated(value="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 or Lustre file system.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdministrativeAction.Builder

Method Summary

Modifier and Type	Method and 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() Provides the percent complete of a STORAGE_OPTIMIZATION administrative action.
Instant	requestTime() Time that the administrative action request was received.
List<SdkField<?>>	sdkFields()
static Class<? extends AdministrativeAction.Builder>	serializableBuilderClass()
Status	status() Describes the status of the administrative action, as follows:
String	statusAsString() Describes the status of the administrative action, as follows:
FileSystem	targetFileSystemValues() Describes the target value for the administration action, provided in the UpdateFileSystem operation.
AdministrativeAction.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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()

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.

requestTime

public final Instant requestTime()

Time that the administrative action request was received.

Returns:

Time that the administrative action request was received.

status

public final 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.

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:

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

statusAsString

public final String statusAsString()

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.

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:

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

targetFileSystemValues

public final FileSystem targetFileSystemValues()

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.

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.

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