Class HookProgressEvent

java.lang.Object
software.amazon.awssdk.services.cloudcontrol.model.HookProgressEvent
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HookProgressEvent.Builder,HookProgressEvent>
@Generated("software.amazon.awssdk:codegen") public final class HookProgressEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HookProgressEvent.Builder,HookProgressEvent>

Represents the current status of applicable Hooks for a resource operation request. It contains list of Hook invocation information for the resource specified in the request since the same target can invoke multiple Hooks. For more information, see Managing resource operation requests with Amazon Web Services Cloud Control API .

See Also:

  • Method Details

    • hookTypeName

      public final String hookTypeName()

      The type name of the Hook being invoked.

      Returns:
      The type name of the Hook being invoked.

    • hookTypeVersionId

      public final String hookTypeVersionId()

      The type version of the Hook being invoked.

      Returns:
      The type version of the Hook being invoked.

    • hookTypeArn

      public final String hookTypeArn()

      The ARN of the Hook being invoked.

      Returns:
      The ARN of the Hook being invoked.

    • invocationPoint

      public final String invocationPoint()

      States whether the Hook is invoked before or after resource provisioning.

      Returns:
      States whether the Hook is invoked before or after resource provisioning.

    • hookStatus

      public final String hookStatus()

      The status of the Hook invocation. The following are potential statuses:

      • HOOK_PENDING: The Hook was added to the invocation plan, but not yet invoked.

      • HOOK_IN_PROGRESS: The Hook was invoked, but hasn't completed.

      • HOOK_COMPLETE_SUCCEEDED: The Hook invocation is complete with a successful result.

      • HOOK_COMPLETE_FAILED: The Hook invocation is complete with a failed result.

      • HOOK_FAILED: The Hook invocation didn't complete successfully.

      Returns:
      The status of the Hook invocation. The following are potential statuses:

      • HOOK_PENDING: The Hook was added to the invocation plan, but not yet invoked.

      • HOOK_IN_PROGRESS: The Hook was invoked, but hasn't completed.

      • HOOK_COMPLETE_SUCCEEDED: The Hook invocation is complete with a successful result.

      • HOOK_COMPLETE_FAILED: The Hook invocation is complete with a failed result.

      • HOOK_FAILED: The Hook invocation didn't complete successfully.

    • hookEventTime

      public final Instant hookEventTime()

      The time that the Hook invocation request initiated.

      Returns:
      The time that the Hook invocation request initiated.

    • hookStatusMessage

      public final String hookStatusMessage()

      The message explaining the current Hook status.

      Returns:
      The message explaining the current Hook status.

    • failureMode

      public final String failureMode()

      The failure mode of the invocation. The following are the potential statuses:

      • FAIL: This will fail the Hook invocation and the request associated with it.

      • WARN: This will fail the Hook invocation, but not the request associated with it.

      Returns:
      The failure mode of the invocation. The following are the potential statuses:

      • FAIL: This will fail the Hook invocation and the request associated with it.

      • WARN: This will fail the Hook invocation, but not the request associated with it.

    • toBuilder

      public HookProgressEvent.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<HookProgressEvent.Builder,HookProgressEvent>
      Returns:
      a builder for type T

    • builder

      public static HookProgressEvent.Builder builder()

    • serializableBuilderClass

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