Interface HookProgressEvent.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<HookProgressEvent.Builder,
,HookProgressEvent> SdkBuilder<HookProgressEvent.Builder,
,HookProgressEvent> SdkPojo
- Enclosing class:
HookProgressEvent
-
Method Summary
Modifier and TypeMethodDescriptionfailureMode
(String failureMode) The failure mode of the invocation.hookEventTime
(Instant hookEventTime) The time that the Hook invocation request initiated.hookStatus
(String hookStatus) The status of the Hook invocation.hookStatusMessage
(String hookStatusMessage) The message explaining the current Hook status.hookTypeArn
(String hookTypeArn) The ARN of the Hook being invoked.hookTypeName
(String hookTypeName) The type name of the Hook being invoked.hookTypeVersionId
(String hookTypeVersionId) The type version of the Hook being invoked.invocationPoint
(String invocationPoint) States whether the Hook is invoked before or after resource provisioning.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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
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
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
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
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
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.
-
-