Package software.amazon.awssdk.services.cloudformation.model

Class HookResultSummary

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.HookResultSummary

All Implemented Interfaces:

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

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

Describes a Hook invocation, its status, and the reason for its status.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HookResultSummary.Builder

Method Summary

Modifier and Type	Method	Description
static HookResultSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
HookFailureMode	failureMode()	The failure mode of the invocation.
String	failureModeAsString()	The failure mode of the invocation.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	hookStatusReason()	A description of the Hook results status.
HookInvocationPoint	invocationPoint()	The exact point in the provisioning logic where the Hook runs.
String	invocationPointAsString()	The exact point in the provisioning logic where the Hook runs.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends HookResultSummary.Builder>	serializableBuilderClass()
HookStatus	status()	The state of the Hook invocation.
String	statusAsString()	The state of the Hook invocation.
HookResultSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	typeConfigurationVersionId()	The version of the Hook type configuration.
String	typeName()	The type name of the Hook being invoked.
String	typeVersionId()	The version of the Hook being invoked.

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

invocationPoint

public final HookInvocationPoint invocationPoint()

The exact point in the provisioning logic where the Hook runs.

If the service returns an enum value that is not available in the current SDK version, invocationPoint will return HookInvocationPoint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from invocationPointAsString().

Returns:

The exact point in the provisioning logic where the Hook runs.

See Also:

HookInvocationPoint

invocationPointAsString

public final String invocationPointAsString()

The exact point in the provisioning logic where the Hook runs.

If the service returns an enum value that is not available in the current SDK version, invocationPoint will return HookInvocationPoint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from invocationPointAsString().

Returns:

The exact point in the provisioning logic where the Hook runs.

See Also:

HookInvocationPoint

failureMode

public final HookFailureMode failureMode()

The failure mode of the invocation. The following are potential modes:

• FAIL: If the hook invocation returns a failure, then the requested target operation should fail.

• WARN: If the hook invocation returns a failure, then the requested target operation should warn.

If the service returns an enum value that is not available in the current SDK version, failureMode will return HookFailureMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureModeAsString().

Returns:

The failure mode of the invocation. The following are potential modes:

• FAIL: If the hook invocation returns a failure, then the requested target operation should fail.

• WARN: If the hook invocation returns a failure, then the requested target operation should warn.

See Also:

HookFailureMode

failureModeAsString

public final String failureModeAsString()

The failure mode of the invocation. The following are potential modes:

• FAIL: If the hook invocation returns a failure, then the requested target operation should fail.

• WARN: If the hook invocation returns a failure, then the requested target operation should warn.

If the service returns an enum value that is not available in the current SDK version, failureMode will return HookFailureMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureModeAsString().

Returns:

The failure mode of the invocation. The following are potential modes:

• FAIL: If the hook invocation returns a failure, then the requested target operation should fail.

• WARN: If the hook invocation returns a failure, then the requested target operation should warn.

See Also:

HookFailureMode

typeName

public final String typeName()

The type name of the Hook being invoked.

Returns:

The type name of the Hook being invoked.

typeVersionId

public final String typeVersionId()

The version of the Hook being invoked.

Returns:

The version of the Hook being invoked.

typeConfigurationVersionId

public final String typeConfigurationVersionId()

The version of the Hook type configuration.

Returns:

The version of the Hook type configuration.

status

public final HookStatus status()

The state of the Hook invocation.

If the service returns an enum value that is not available in the current SDK version, status will return HookStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The state of the Hook invocation.

See Also:

HookStatus

statusAsString

public final String statusAsString()

The state of the Hook invocation.

If the service returns an enum value that is not available in the current SDK version, status will return HookStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The state of the Hook invocation.

See Also:

HookStatus

hookStatusReason

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

Returns:

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.

toBuilder

public HookResultSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HookResultSummary.Builder,HookResultSummary>

builder

public static HookResultSummary.Builder builder()

serializableBuilderClass

public static Class<? extends HookResultSummary.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