Class OperationEvent
- java.lang.Object
-
- software.amazon.awssdk.services.cloudformation.model.OperationEvent
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<OperationEvent.Builder,OperationEvent>
@Generated("software.amazon.awssdk:codegen") public final class OperationEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OperationEvent.Builder,OperationEvent>
Contains detailed information about an event that occurred during a CloudFormation operation.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceOperationEvent.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OperationEvent.Builderbuilder()StringclientRequestToken()A unique identifier for the request that initiated this operation.DetailedStatusdetailedStatus()Additional status information about the operation.StringdetailedStatusAsString()Additional status information about the operation.InstantendTime()The time when the event ended.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeventId()A unique identifier for this event.EventTypeeventType()The type of event.StringeventTypeAsString()The type of event.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()HookFailureModehookFailureMode()Specifies how Hook failures are handled.StringhookFailureModeAsString()Specifies how Hook failures are handled.HookInvocationPointhookInvocationPoint()The point in the operation lifecycle when the Hook was invoked.StringhookInvocationPointAsString()The point in the operation lifecycle when the Hook was invoked.HookStatushookStatus()The status of the Hook invocation.StringhookStatusAsString()The status of the Hook invocation.StringhookStatusReason()Additional information about the Hook status.StringhookType()The type name of the Hook that was invoked.StringlogicalResourceId()The logical name of the resource as specified in the template.StringoperationId()The unique identifier of the operation this event belongs to.BeaconStackOperationStatusoperationStatus()The current status of the operation.StringoperationStatusAsString()The current status of the operation.OperationTypeoperationType()The type of operation.StringoperationTypeAsString()The type of operation.StringphysicalResourceId()The name or unique identifier that corresponds to a physical instance ID of a resource.StringresourceProperties()The properties used to create the resource.ResourceStatusresourceStatus()Current status of the resource.StringresourceStatusAsString()Current status of the resource.StringresourceStatusReason()Success or failure message associated with the resource.StringresourceType()Type of resource.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends OperationEvent.Builder>serializableBuilderClass()StringstackId()The unique ID name of the instance of the stack.InstantstartTime()The time when the event started.Instanttimestamp()Time the status was updated.OperationEvent.BuildertoBuilder()StringtoString()Returns a string representation of this object.HookFailureModevalidationFailureMode()Specifies how validation failures are handled.StringvalidationFailureModeAsString()Specifies how validation failures are handled.StringvalidationName()The name of the validation that was performed.StringvalidationPath()The path within the resource where the validation was applied.ValidationStatusvalidationStatus()The status of the validation.StringvalidationStatusAsString()The status of the validation.StringvalidationStatusReason()Additional information about the validation status.-
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
-
eventId
public final String eventId()
A unique identifier for this event.
- Returns:
- A unique identifier for this event.
-
stackId
public final String stackId()
The unique ID name of the instance of the stack.
- Returns:
- The unique ID name of the instance of the stack.
-
operationId
public final String operationId()
The unique identifier of the operation this event belongs to.
- Returns:
- The unique identifier of the operation this event belongs to.
-
operationType
public final OperationType operationType()
The type of operation.
If the service returns an enum value that is not available in the current SDK version,
operationTypewill returnOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromoperationTypeAsString().- Returns:
- The type of operation.
- See Also:
OperationType
-
operationTypeAsString
public final String operationTypeAsString()
The type of operation.
If the service returns an enum value that is not available in the current SDK version,
operationTypewill returnOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromoperationTypeAsString().- Returns:
- The type of operation.
- See Also:
OperationType
-
operationStatus
public final BeaconStackOperationStatus operationStatus()
The current status of the operation.
If the service returns an enum value that is not available in the current SDK version,
operationStatuswill returnBeaconStackOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromoperationStatusAsString().- Returns:
- The current status of the operation.
- See Also:
BeaconStackOperationStatus
-
operationStatusAsString
public final String operationStatusAsString()
The current status of the operation.
If the service returns an enum value that is not available in the current SDK version,
operationStatuswill returnBeaconStackOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromoperationStatusAsString().- Returns:
- The current status of the operation.
- See Also:
BeaconStackOperationStatus
-
eventType
public final EventType eventType()
The type of event.
If the service returns an enum value that is not available in the current SDK version,
eventTypewill returnEventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeventTypeAsString().- Returns:
- The type of event.
- See Also:
EventType
-
eventTypeAsString
public final String eventTypeAsString()
The type of event.
If the service returns an enum value that is not available in the current SDK version,
eventTypewill returnEventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeventTypeAsString().- Returns:
- The type of event.
- See Also:
EventType
-
logicalResourceId
public final String logicalResourceId()
The logical name of the resource as specified in the template.
- Returns:
- The logical name of the resource as specified in the template.
-
physicalResourceId
public final String physicalResourceId()
The name or unique identifier that corresponds to a physical instance ID of a resource.
- Returns:
- The name or unique identifier that corresponds to a physical instance ID of a resource.
-
resourceType
public final String resourceType()
Type of resource.
- Returns:
- Type of resource.
-
timestamp
public final Instant timestamp()
Time the status was updated.
- Returns:
- Time the status was updated.
-
startTime
public final Instant startTime()
The time when the event started.
- Returns:
- The time when the event started.
-
endTime
public final Instant endTime()
The time when the event ended.
- Returns:
- The time when the event ended.
-
resourceStatus
public final ResourceStatus resourceStatus()
Current status of the resource.
If the service returns an enum value that is not available in the current SDK version,
resourceStatuswill returnResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceStatusAsString().- Returns:
- Current status of the resource.
- See Also:
ResourceStatus
-
resourceStatusAsString
public final String resourceStatusAsString()
Current status of the resource.
If the service returns an enum value that is not available in the current SDK version,
resourceStatuswill returnResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceStatusAsString().- Returns:
- Current status of the resource.
- See Also:
ResourceStatus
-
resourceStatusReason
public final String resourceStatusReason()
Success or failure message associated with the resource.
- Returns:
- Success or failure message associated with the resource.
-
resourceProperties
public final String resourceProperties()
The properties used to create the resource.
- Returns:
- The properties used to create the resource.
-
clientRequestToken
public final String clientRequestToken()
A unique identifier for the request that initiated this operation.
- Returns:
- A unique identifier for the request that initiated this operation.
-
hookType
public final String hookType()
The type name of the Hook that was invoked.
- Returns:
- The type name of the Hook that was invoked.
-
hookStatus
public final HookStatus hookStatus()
The status of the Hook invocation.
If the service returns an enum value that is not available in the current SDK version,
hookStatuswill returnHookStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromhookStatusAsString().- Returns:
- The status of the Hook invocation.
- See Also:
HookStatus
-
hookStatusAsString
public final String hookStatusAsString()
The status of the Hook invocation.
If the service returns an enum value that is not available in the current SDK version,
hookStatuswill returnHookStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromhookStatusAsString().- Returns:
- The status of the Hook invocation.
- See Also:
HookStatus
-
hookStatusReason
public final String hookStatusReason()
Additional information about the Hook status.
- Returns:
- Additional information about the Hook status.
-
hookInvocationPoint
public final HookInvocationPoint hookInvocationPoint()
The point in the operation lifecycle when the Hook was invoked.
If the service returns an enum value that is not available in the current SDK version,
hookInvocationPointwill returnHookInvocationPoint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromhookInvocationPointAsString().- Returns:
- The point in the operation lifecycle when the Hook was invoked.
- See Also:
HookInvocationPoint
-
hookInvocationPointAsString
public final String hookInvocationPointAsString()
The point in the operation lifecycle when the Hook was invoked.
If the service returns an enum value that is not available in the current SDK version,
hookInvocationPointwill returnHookInvocationPoint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromhookInvocationPointAsString().- Returns:
- The point in the operation lifecycle when the Hook was invoked.
- See Also:
HookInvocationPoint
-
hookFailureMode
public final HookFailureMode hookFailureMode()
Specifies how Hook failures are handled.
If the service returns an enum value that is not available in the current SDK version,
hookFailureModewill returnHookFailureMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromhookFailureModeAsString().- Returns:
- Specifies how Hook failures are handled.
- See Also:
HookFailureMode
-
hookFailureModeAsString
public final String hookFailureModeAsString()
Specifies how Hook failures are handled.
If the service returns an enum value that is not available in the current SDK version,
hookFailureModewill returnHookFailureMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromhookFailureModeAsString().- Returns:
- Specifies how Hook failures are handled.
- See Also:
HookFailureMode
-
detailedStatus
public final DetailedStatus detailedStatus()
Additional status information about the operation.
If the service returns an enum value that is not available in the current SDK version,
detailedStatuswill returnDetailedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdetailedStatusAsString().- Returns:
- Additional status information about the operation.
- See Also:
DetailedStatus
-
detailedStatusAsString
public final String detailedStatusAsString()
Additional status information about the operation.
If the service returns an enum value that is not available in the current SDK version,
detailedStatuswill returnDetailedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdetailedStatusAsString().- Returns:
- Additional status information about the operation.
- See Also:
DetailedStatus
-
validationFailureMode
public final HookFailureMode validationFailureMode()
Specifies how validation failures are handled.
If the service returns an enum value that is not available in the current SDK version,
validationFailureModewill returnHookFailureMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvalidationFailureModeAsString().- Returns:
- Specifies how validation failures are handled.
- See Also:
HookFailureMode
-
validationFailureModeAsString
public final String validationFailureModeAsString()
Specifies how validation failures are handled.
If the service returns an enum value that is not available in the current SDK version,
validationFailureModewill returnHookFailureMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvalidationFailureModeAsString().- Returns:
- Specifies how validation failures are handled.
- See Also:
HookFailureMode
-
validationName
public final String validationName()
The name of the validation that was performed.
- Returns:
- The name of the validation that was performed.
-
validationStatus
public final ValidationStatus validationStatus()
The status of the validation.
If the service returns an enum value that is not available in the current SDK version,
validationStatuswill returnValidationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvalidationStatusAsString().- Returns:
- The status of the validation.
- See Also:
ValidationStatus
-
validationStatusAsString
public final String validationStatusAsString()
The status of the validation.
If the service returns an enum value that is not available in the current SDK version,
validationStatuswill returnValidationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvalidationStatusAsString().- Returns:
- The status of the validation.
- See Also:
ValidationStatus
-
validationStatusReason
public final String validationStatusReason()
Additional information about the validation status.
- Returns:
- Additional information about the validation status.
-
validationPath
public final String validationPath()
The path within the resource where the validation was applied.
- Returns:
- The path within the resource where the validation was applied.
-
toBuilder
public OperationEvent.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<OperationEvent.Builder,OperationEvent>
-
builder
public static OperationEvent.Builder builder()
-
serializableBuilderClass
public static Class<? extends OperationEvent.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-