Class ProgressEvent

java.lang.Object
software.amazon.awssdk.services.cloudcontrol.model.ProgressEvent
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ProgressEvent.Builder,ProgressEvent>
@Generated("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:

  • Method Details

    • 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.

    • hooksRequestToken

      public final String hooksRequestToken()

      The unique token representing the Hooks operation for the request.

      Returns:
      The unique token representing the Hooks operation for the 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ProgressEvent.Builder,ProgressEvent>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.