Package software.amazon.awssdk.services.cloudcontrol.model

Interface HookProgressEvent.Builder

    • Method Detail

      • hookTypeName

        HookProgressEvent.Builder hookTypeName​(String hookTypeName)

        The type name of the Hook being invoked.

        Parameters:
        hookTypeName - The type name of the Hook being invoked.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hookTypeVersionId

        HookProgressEvent.Builder hookTypeVersionId​(String hookTypeVersionId)

        The type version of the Hook being invoked.

        Parameters:
        hookTypeVersionId - The type version of the Hook being invoked.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hookTypeArn

        HookProgressEvent.Builder hookTypeArn​(String hookTypeArn)

        The ARN of the Hook being invoked.

        Parameters:
        hookTypeArn - The ARN of the Hook being invoked.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • invocationPoint

        HookProgressEvent.Builder invocationPoint​(String invocationPoint)

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

        Parameters:
        invocationPoint - States whether the Hook is invoked before or after resource provisioning.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hookStatus

        HookProgressEvent.Builder hookStatus​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • hookEventTime

        HookProgressEvent.Builder hookEventTime​(Instant hookEventTime)

        The time that the Hook invocation request initiated.

        Parameters:
        hookEventTime - The time that the Hook invocation request initiated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hookStatusMessage

        HookProgressEvent.Builder hookStatusMessage​(String hookStatusMessage)

        The message explaining the current Hook status.

        Parameters:
        hookStatusMessage - The message explaining the current Hook status.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureMode

        HookProgressEvent.Builder failureMode​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.