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

Class HookProgressEvent

java.lang.Object

software.amazon.awssdk.services.cloudcontrol.model.HookProgressEvent

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HookProgressEvent.Builder,HookProgressEvent>

@Generated("software.amazon.awssdk:codegen")
public final class HookProgressEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HookProgressEvent.Builder,HookProgressEvent>

Represents the current status of applicable Hooks for a resource operation request. It contains list of Hook invocation information for the resource specified in the request since the same target can invoke multiple Hooks. For more information, see Managing resource operation requests with Amazon Web Services Cloud Control API .

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HookProgressEvent.Builder

Method Summary

Modifier and Type	Method	Description
static HookProgressEvent.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureMode()	The failure mode of the invocation.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	hookEventTime()	The time that the Hook invocation request initiated.
String	hookStatus()	The status of the Hook invocation.
String	hookStatusMessage()	The message explaining the current Hook status.
String	hookTypeArn()	The ARN of the Hook being invoked.
String	hookTypeName()	The type name of the Hook being invoked.
String	hookTypeVersionId()	The type version of the Hook being invoked.
String	invocationPoint()	States whether the Hook is invoked before or after resource provisioning.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends HookProgressEvent.Builder>	serializableBuilderClass()
HookProgressEvent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hookTypeName

public final String hookTypeName()

The type name of the Hook being invoked.

Returns:

The type name of the Hook being invoked.

hookTypeVersionId

public final String hookTypeVersionId()

The type version of the Hook being invoked.

Returns:

The type version of the Hook being invoked.

hookTypeArn

public final String hookTypeArn()

The ARN of the Hook being invoked.

Returns:

The ARN of the Hook being invoked.

invocationPoint

public final String invocationPoint()

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

Returns:

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

hookStatus

public final 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.

Returns:

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.

hookEventTime

public final Instant hookEventTime()

The time that the Hook invocation request initiated.

Returns:

The time that the Hook invocation request initiated.

hookStatusMessage

public final String hookStatusMessage()

The message explaining the current Hook status.

Returns:

The message explaining the current Hook status.

failureMode

public final 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.

Returns:

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.

toBuilder

public HookProgressEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HookProgressEvent.Builder,HookProgressEvent>

builder

public static HookProgressEvent.Builder builder()

serializableBuilderClass

public static Class<? extends HookProgressEvent.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo