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>

A ListHookResults call returns a summary of a Hook invocation.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface HookResultSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`hookExecutionTarget()`	The Amazon Resource Name (ARN) of the target stack or request token of the Cloud Control API operation.
`String`	`hookResultId()`	The unique identifier for this Hook invocation result.
`String`	`hookStatusReason()`	A description of the Hook results status.
`HookInvocationPoint`	`invocationPoint()`	The specific point in the provisioning process where the Hook is invoked.
`String`	`invocationPointAsString()`	The specific point in the provisioning process where the Hook is invoked.
`Instant`	`invokedAt()`	The timestamp when the Hook was invoked.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends HookResultSummary.Builder>`	`serializableBuilderClass()`
`HookStatus`	`status()`	The status of the Hook invocation.
`String`	`statusAsString()`	The status of the Hook invocation.
`String`	`targetId()`	The unique identifier of the Hook invocation target.
`ListHookResultsTargetType`	`targetType()`	The target type that the Hook was invoked against.
`String`	`targetTypeAsString()`	The target type that the Hook was invoked against.
`HookResultSummary.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`typeArn()`	The ARN of the Hook that was invoked.
`String`	`typeConfigurationVersionId()`	The version of the Hook configuration.
`String`	`typeName()`	The name of the Hook that was invoked.
`String`	`typeVersionId()`	The version of the Hook that was 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
  - hookResultId
```
public final String hookResultId()
```
    The unique identifier for this Hook invocation result.
    
    Returns:
    
    The unique identifier for this Hook invocation result.
  - invocationPoint
```
public final HookInvocationPoint invocationPoint()
```
    The specific point in the provisioning process where the Hook is invoked.
    
    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 specific point in the provisioning process where the Hook is invoked.
    
    See Also:
    
    HookInvocationPoint
  - invocationPointAsString
```
public final String invocationPointAsString()
```
    The specific point in the provisioning process where the Hook is invoked.
    
    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 specific point in the provisioning process where the Hook is invoked.
    
    See Also:
    
    HookInvocationPoint
  - failureMode
```
public final HookFailureMode failureMode()
```
    The failure mode of the invocation.
    
    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.
    
    See Also:
    
    HookFailureMode
  - failureModeAsString
```
public final String failureModeAsString()
```
    The failure mode of the invocation.
    
    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.
    
    See Also:
    
    HookFailureMode
  - typeName
```
public final String typeName()
```
    The name of the Hook that was invoked.
    
    Returns:
    
    The name of the Hook that was invoked.
  - typeVersionId
```
public final String typeVersionId()
```
    The version of the Hook that was invoked.
    
    Returns:
    
    The version of the Hook that was invoked.
  - typeConfigurationVersionId
```
public final String typeConfigurationVersionId()
```
    The version of the Hook configuration.
    
    Returns:
    
    The version of the Hook configuration.
  - status
```
public final 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.
    
    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 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.
    
    See Also:
    
    HookStatus
  - statusAsString
```
public final String statusAsString()
```
    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.
    
    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 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.
    
    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.
  - invokedAt
```
public final Instant invokedAt()
```
    The timestamp when the Hook was invoked.
    
    Only shown in responses when the request does not specify TargetType and TargetId filters.
    
    Returns:
    
    The timestamp when the Hook was invoked.
    
    Only shown in responses when the request does not specify TargetType and TargetId filters.
  - targetType
```
public final ListHookResultsTargetType targetType()
```
    The target type that the Hook was invoked against.
    
    If the service returns an enum value that is not available in the current SDK version, targetType will return ListHookResultsTargetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().
    
    Returns:
    
    The target type that the Hook was invoked against.
    
    See Also:
    
    ListHookResultsTargetType
  - targetTypeAsString
```
public final String targetTypeAsString()
```
    The target type that the Hook was invoked against.
    
    If the service returns an enum value that is not available in the current SDK version, targetType will return ListHookResultsTargetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().
    
    Returns:
    
    The target type that the Hook was invoked against.
    
    See Also:
    
    ListHookResultsTargetType
  - targetId
```
public final String targetId()
```
    The unique identifier of the Hook invocation target.
    
    Returns:
    
    The unique identifier of the Hook invocation target.
  - typeArn
```
public final String typeArn()
```
    The ARN of the Hook that was invoked.
    
    Returns:
    
    The ARN of the Hook that was invoked.
  - hookExecutionTarget
```
public final String hookExecutionTarget()
```
    The Amazon Resource Name (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:
    
    The Amazon Resource Name (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.
  - 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

Class HookResultSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hookResultId

invocationPoint

invocationPointAsString

failureMode

failureModeAsString

typeName

typeVersionId

typeConfigurationVersionId

status

statusAsString

hookStatusReason

invokedAt

targetType

targetTypeAsString

targetId

typeArn

hookExecutionTarget

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField