software.amazon.awssdk.services.cloudcontrol.model

Class ProgressEvent

java.lang.Object

software.amazon.awssdk.services.cloudcontrol.model.ProgressEvent

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class ProgressEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ProgressEvent.Builder,ProgressEvent>

Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the Amazon Web Services Cloud Control API User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProgressEvent.Builder

Method Summary

Modifier and Type	Method and Description
static ProgressEvent.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
HandlerErrorCode	errorCode() For requests with a status of FAILED, the associated error code.
String	errorCodeAsString() For requests with a status of FAILED, the associated error code.
Instant	eventTime() When the resource operation request was initiated.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identifier() The primary identifier for the resource.
Operation	operation() The resource operation type.
String	operationAsString() The resource operation type.
OperationStatus	operationStatus() The current status of the resource operation request.
String	operationStatusAsString() The current status of the resource operation request.
String	requestToken() The unique token representing this resource operation request.
String	resourceModel() A JSON string containing the resource model, consisting of each resource property and its current value.
Instant	retryAfter() When to next request the status of this resource operation request.
List<SdkField<?>>	sdkFields()
static Class<? extends ProgressEvent.Builder>	serializableBuilderClass()
String	statusMessage() Any message explaining the current status.
ProgressEvent.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	typeName() The name of the resource type used in the operation.

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

typeName

public final String typeName()

The name of the resource type used in the operation.

Returns:

The name of the resource type used in the operation.

identifier

public final String identifier()

The primary identifier for the resource.

In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.

Returns:

The primary identifier for the resource.

In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.

requestToken

public final String requestToken()

The unique token representing this resource operation request.

Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

Returns:

The unique token representing this resource operation request.

Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

operation

public final Operation operation()

The resource operation type.

If the service returns an enum value that is not available in the current SDK version, operation will return Operation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().

Returns:

The resource operation type.

See Also:

Operation

operationAsString

public final String operationAsString()

The resource operation type.

If the service returns an enum value that is not available in the current SDK version, operation will return Operation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().

Returns:

The resource operation type.

See Also:

Operation

operationStatus

public final OperationStatus operationStatus()

The current status of the resource operation request.

• PENDING: The resource operation hasn't yet started.

• IN_PROGRESS: The resource operation is currently in progress.

• SUCCESS: The resource operation has successfully completed.

• FAILED: The resource operation has failed. Refer to the error code and status message for more information.

• CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

• CANCEL_COMPLETE: The resource operation has been canceled.

If the service returns an enum value that is not available in the current SDK version, operationStatus will return OperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationStatusAsString().

Returns:

The current status of the resource operation request.

• PENDING: The resource operation hasn't yet started.

• IN_PROGRESS: The resource operation is currently in progress.

• SUCCESS: The resource operation has successfully completed.

• FAILED: The resource operation has failed. Refer to the error code and status message for more information.

• CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

• CANCEL_COMPLETE: The resource operation has been canceled.

See Also:

OperationStatus

operationStatusAsString

public final String operationStatusAsString()

The current status of the resource operation request.

• PENDING: The resource operation hasn't yet started.

• IN_PROGRESS: The resource operation is currently in progress.

• SUCCESS: The resource operation has successfully completed.

• FAILED: The resource operation has failed. Refer to the error code and status message for more information.

• CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

• CANCEL_COMPLETE: The resource operation has been canceled.

If the service returns an enum value that is not available in the current SDK version, operationStatus will return OperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationStatusAsString().

Returns:

The current status of the resource operation request.

• PENDING: The resource operation hasn't yet started.

• IN_PROGRESS: The resource operation is currently in progress.

• SUCCESS: The resource operation has successfully completed.

• FAILED: The resource operation has failed. Refer to the error code and status message for more information.

• CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

• CANCEL_COMPLETE: The resource operation has been canceled.

See Also:

OperationStatus

eventTime

public final Instant eventTime()

When the resource operation request was initiated.

Returns:

When the resource operation request was initiated.

resourceModel

public final String resourceModel()

A JSON string containing the resource model, consisting of each resource property and its current value.

Returns:

A JSON string containing the resource model, consisting of each resource property and its current value.

statusMessage

public final String statusMessage()

Any message explaining the current status.

Returns:

Any message explaining the current status.

errorCode

public final HandlerErrorCode errorCode()

For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

If the service returns an enum value that is not available in the current SDK version, errorCode will return HandlerErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().

Returns:

For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

See Also:

HandlerErrorCode

errorCodeAsString

public final String errorCodeAsString()

For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

If the service returns an enum value that is not available in the current SDK version, errorCode will return HandlerErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().

Returns:

For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

See Also:

HandlerErrorCode

retryAfter

public final Instant retryAfter()

When to next request the status of this resource operation request.

Returns:

When to next request the status of this resource operation request.

toBuilder

public ProgressEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProgressEvent.Builder,ProgressEvent>

builder

public static ProgressEvent.Builder builder()

serializableBuilderClass

public static Class<? extends ProgressEvent.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