Interface GetHookResultResponse.Builder

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

  • Method Details

    • hookResultId

      GetHookResultResponse.Builder hookResultId(String hookResultId)

      The unique identifier of the Hook result.

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

    • invocationPoint

      GetHookResultResponse.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

      GetHookResultResponse.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

      GetHookResultResponse.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

      GetHookResultResponse.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

      GetHookResultResponse.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.

    • originalTypeName

      GetHookResultResponse.Builder originalTypeName(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.

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

    • typeVersionId

      GetHookResultResponse.Builder typeVersionId(String typeVersionId)

      The version identifier of the Hook that was invoked.

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

    • typeConfigurationVersionId

      GetHookResultResponse.Builder typeConfigurationVersionId(String typeConfigurationVersionId)

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

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

    • typeArn

      GetHookResultResponse.Builder typeArn(String typeArn)

      The Amazon Resource Name (ARN) of the Hook.

      Parameters:
      typeArn - The Amazon Resource Name (ARN) of the Hook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetHookResultResponse.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

      GetHookResultResponse.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

      GetHookResultResponse.Builder hookStatusReason(String hookStatusReason)

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

      Parameters:
      hookStatusReason - A message that provides additional details about the Hook invocation status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • invokedAt

      GetHookResultResponse.Builder invokedAt(Instant invokedAt)

      The timestamp when the Hook was invoked.

      Parameters:
      invokedAt - The timestamp when the Hook was invoked.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • target

      GetHookResultResponse.Builder target(HookTarget target)

      Information about the target of the Hook invocation.

      Parameters:
      target - Information about the target of the Hook invocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • target

      default GetHookResultResponse.Builder target(Consumer<HookTarget.Builder> target)

      Information about the target of the Hook invocation.

      This is a convenience method that creates an instance of the HookTarget.Builder avoiding the need to create one manually via HookTarget.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to target(HookTarget).

      Parameters:
      target - a consumer that will call methods on HookTarget.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • annotations

      GetHookResultResponse.Builder annotations(Collection<Annotation> annotations)

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

      Parameters:
      annotations - A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • annotations

      GetHookResultResponse.Builder annotations(Annotation... annotations)

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

      Parameters:
      annotations - A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • annotations

      GetHookResultResponse.Builder annotations(Consumer<Annotation.Builder>... annotations)

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

      This is a convenience method that creates an instance of the Annotation.Builder avoiding the need to create one manually via Annotation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to annotations(List<Annotation>).

      Parameters:
      annotations - a consumer that will call methods on Annotation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: