Package software.amazon.awssdk.services.cloudformation.model

Class GetHookResultResponse

    • Method Detail

      • hookResultId

        public final String hookResultId()

        The unique identifier of the Hook result.

        Returns:
        The unique identifier of the Hook result.

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

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

      • typeName

        public final String typeName()

        The name of the Hook that was invoked.

        Returns:
        The name of the Hook that was invoked.

      • originalTypeName

        public final String originalTypeName()

        The original public type name of the Hook when an alias is used.

        For example, if you activate AWS::Hooks::GuardHook with alias MyCompany::Custom::GuardHook, then TypeName will be MyCompany::Custom::GuardHook and OriginalTypeName will be AWS::Hooks::GuardHook.

        Returns:
        The original public type name of the Hook when an alias is used.

        For example, if you activate AWS::Hooks::GuardHook with alias MyCompany::Custom::GuardHook, then TypeName will be MyCompany::Custom::GuardHook and OriginalTypeName will be AWS::Hooks::GuardHook.

      • typeVersionId

        public final String typeVersionId()

        The version identifier of the Hook that was invoked.

        Returns:
        The version identifier of the Hook that was invoked.

      • typeConfigurationVersionId

        public final String typeConfigurationVersionId()

        The version identifier of the Hook configuration data that was used during invocation.

        Returns:
        The version identifier of the Hook configuration data that was used during invocation.

      • typeArn

        public final String typeArn()

        The Amazon Resource Name (ARN) of the Hook.

        Returns:
        The Amazon Resource Name (ARN) of the Hook.

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

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

      • hookStatusReason

        public final String hookStatusReason()

        A message that provides additional details about the Hook invocation status.

        Returns:
        A message that provides additional details about the Hook invocation status.

      • invokedAt

        public final Instant invokedAt()

        The timestamp when the Hook was invoked.

        Returns:
        The timestamp when the Hook was invoked.

      • target

        public final HookTarget target()

        Information about the target of the Hook invocation.

        Returns:
        Information about the target of the Hook invocation.

      • hasAnnotations

        public final boolean hasAnnotations()
        For responses, this returns true if the service returned a value for the Annotations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • annotations

        public final List<Annotation> annotations()

        A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAnnotations() method.

        Returns:
        A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.

      • 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