Interface HookResultSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<HookResultSummary.Builder,HookResultSummary>, SdkBuilder<HookResultSummary.Builder,HookResultSummary>, SdkPojo
Enclosing class:
HookResultSummary
@Mutable @NotThreadSafe public static interface HookResultSummary.Builder extends SdkPojo, CopyableBuilder<HookResultSummary.Builder,HookResultSummary>

  • Method Details

    • hookResultId

      HookResultSummary.Builder hookResultId(String hookResultId)

      The unique identifier for this Hook invocation result.

      Parameters:
      hookResultId - The unique identifier for this Hook invocation result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • invocationPoint

      HookResultSummary.Builder invocationPoint(String invocationPoint)

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

      Parameters:
      invocationPoint - The specific point in the provisioning process where the Hook is invoked.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • invocationPoint

      HookResultSummary.Builder invocationPoint(HookInvocationPoint invocationPoint)

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

      Parameters:
      invocationPoint - The specific point in the provisioning process where the Hook is invoked.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureMode

      HookResultSummary.Builder failureMode(String failureMode)

      The failure mode of the invocation.

      Parameters:
      failureMode - The failure mode of the invocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureMode

      HookResultSummary.Builder failureMode(HookFailureMode failureMode)

      The failure mode of the invocation.

      Parameters:
      failureMode - The failure mode of the invocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • typeName

      HookResultSummary.Builder typeName(String typeName)

      The name of the Hook that was invoked.

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

    • typeVersionId

      HookResultSummary.Builder typeVersionId(String typeVersionId)

      The version of the Hook that was invoked.

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

    • typeConfigurationVersionId

      HookResultSummary.Builder typeConfigurationVersionId(String typeConfigurationVersionId)

      The version of the Hook configuration.

      Parameters:
      typeConfigurationVersionId - The version of the Hook configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      HookResultSummary.Builder status(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      HookResultSummary.Builder status(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hookStatusReason

      HookResultSummary.Builder hookStatusReason(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.

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

    • invokedAt

      HookResultSummary.Builder invokedAt(Instant invokedAt)

      The timestamp when the Hook was invoked.

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

      Parameters:
      invokedAt - The timestamp when the Hook was invoked.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetType

      HookResultSummary.Builder targetType(String targetType)

      The target type that the Hook was invoked against.

      Parameters:
      targetType - The target type that the Hook was invoked against.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetType

      HookResultSummary.Builder targetType(ListHookResultsTargetType targetType)

      The target type that the Hook was invoked against.

      Parameters:
      targetType - The target type that the Hook was invoked against.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetId

      HookResultSummary.Builder targetId(String targetId)

      The unique identifier of the Hook invocation target.

      Parameters:
      targetId - The unique identifier of the Hook invocation target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • typeArn

      HookResultSummary.Builder typeArn(String typeArn)

      The ARN of the Hook that was invoked.

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

    • hookExecutionTarget

      HookResultSummary.Builder hookExecutionTarget(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.

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