Class HookResultSummary

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

Describes a Hook invocation, its status, and the reason for its status.

See Also:

  • Method Details

    • hookResultId

      public final String hookResultId()

      The unique identifier for this Hook invocation result.

      Returns:
      The unique identifier for this Hook invocation result.

    • invocationPoint

      public final HookInvocationPoint invocationPoint()

      The specific point in the provisioning process where the Hook is invoked.

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

      Returns:
      The specific point in the provisioning process where the Hook is invoked.
      See Also:

    • invocationPointAsString

      public final String invocationPointAsString()

      The specific point in the provisioning process where the Hook is invoked.

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

      Returns:
      The specific point in the provisioning process where the Hook is invoked.
      See Also:

    • failureMode

      public final HookFailureMode failureMode()

      The failure mode of the invocation.

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

      Returns:
      The failure mode of the invocation.
      See Also:

    • failureModeAsString

      public final String failureModeAsString()

      The failure mode of the invocation.

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

      Returns:
      The failure mode of the invocation.
      See Also:

    • typeName

      public final String typeName()

      The name of the Hook that was invoked.

      Returns:
      The name of the Hook that was invoked.

    • typeVersionId

      public final String typeVersionId()

      The version of the Hook that was invoked.

      Returns:
      The version of the Hook that was invoked.

    • typeConfigurationVersionId

      public final String typeConfigurationVersionId()

      The version of the Hook configuration.

      Returns:
      The version of the Hook configuration.

    • status

      public final HookStatus status()

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

      • HOOK_IN_PROGRESS: The Hook is currently running.

      • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

      • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

      • HOOK_FAILED: The Hook encountered an error during execution.

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

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

      • HOOK_IN_PROGRESS: The Hook is currently running.

      • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

      • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

      • HOOK_FAILED: The Hook encountered an error during execution.

      See Also:

    • statusAsString

      public final String statusAsString()

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

      • HOOK_IN_PROGRESS: The Hook is currently running.

      • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

      • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

      • HOOK_FAILED: The Hook encountered an error during execution.

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

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

      • HOOK_IN_PROGRESS: The Hook is currently running.

      • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

      • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

      • HOOK_FAILED: The Hook encountered an error during execution.

      See Also:

    • hookStatusReason

      public final String hookStatusReason()

      A description of the Hook results status. For example, if the Hook result is in a failed state, this may contain additional information for the failed state.

      Returns:
      A description of the Hook results status. For example, if the Hook result is in a failed state, this may contain additional information for the failed state.

    • invokedAt

      public final Instant invokedAt()

      The timestamp when the Hook was invoked.

      Only shown in responses when the request does not specify TargetType and TargetId filters.

      Returns:
      The timestamp when the Hook was invoked.

      Only shown in responses when the request does not specify TargetType and TargetId filters.

    • targetType

      public final ListHookResultsTargetType targetType()

      The target type that the Hook was invoked against.

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

      Returns:
      The target type that the Hook was invoked against.
      See Also:

    • targetTypeAsString

      public final String targetTypeAsString()

      The target type that the Hook was invoked against.

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

      Returns:
      The target type that the Hook was invoked against.
      See Also:

    • targetId

      public final String targetId()

      The unique identifier of the Hook invocation target.

      Returns:
      The unique identifier of the Hook invocation target.

    • typeArn

      public final String typeArn()

      The ARN of the Hook that was invoked.

      Returns:
      The ARN of the Hook that was invoked.

    • hookExecutionTarget

      public final String hookExecutionTarget()

      The ARN of the target stack or request token of the Cloud Control API operation.

      Only shown in responses when the request does not specify TargetType and TargetId filters.

      Returns:
      The ARN of the target stack or request token of the Cloud Control API operation.

      Only shown in responses when the request does not specify TargetType and TargetId filters.

    • toBuilder

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

    • builder

      public static HookResultSummary.Builder builder()

    • serializableBuilderClass

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