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:

  • Method Details

    • 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, operationType will return OperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationTypeAsString().

      Returns:
      The type of operation.
      See Also:

    • 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, operationType will return OperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationTypeAsString().

      Returns:
      The type of operation.
      See Also:

    • 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, operationStatus will return BeaconStackOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationStatusAsString().

      Returns:
      The current status of the operation.
      See Also:

    • 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, operationStatus will return BeaconStackOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationStatusAsString().

      Returns:
      The current status of the operation.
      See Also:

    • 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, eventType will return EventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      The type of event.
      See Also:

    • 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, eventType will return EventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      The type of event.
      See Also:

    • 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, resourceStatus will return ResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceStatusAsString().

      Returns:
      Current status of the resource.
      See Also:

    • 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, resourceStatus will return ResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceStatusAsString().

      Returns:
      Current status of the resource.
      See Also:

    • 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, hookStatus will return HookStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hookStatusAsString().

      Returns:
      The status of the Hook invocation.
      See Also:

    • 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, hookStatus will return HookStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hookStatusAsString().

      Returns:
      The status of the Hook invocation.
      See Also:

    • 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, hookInvocationPoint will return HookInvocationPoint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hookInvocationPointAsString().

      Returns:
      The point in the operation lifecycle when the Hook was invoked.
      See Also:

    • 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, hookInvocationPoint will return HookInvocationPoint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hookInvocationPointAsString().

      Returns:
      The point in the operation lifecycle when the Hook was invoked.
      See Also:

    • 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, hookFailureMode will return HookFailureMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hookFailureModeAsString().

      Returns:
      Specifies how Hook failures are handled.
      See Also:

    • 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, hookFailureMode will return HookFailureMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hookFailureModeAsString().

      Returns:
      Specifies how Hook failures are handled.
      See Also:

    • 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, detailedStatus will return DetailedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from detailedStatusAsString().

      Returns:
      Additional status information about the operation.
      See Also:

    • 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, detailedStatus will return DetailedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from detailedStatusAsString().

      Returns:
      Additional status information about the operation.
      See Also:

    • 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, validationFailureMode will return HookFailureMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from validationFailureModeAsString().

      Returns:
      Specifies how validation failures are handled.
      See Also:

    • 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, validationFailureMode will return HookFailureMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from validationFailureModeAsString().

      Returns:
      Specifies how validation failures are handled.
      See Also:

    • 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, validationStatus will return ValidationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from validationStatusAsString().

      Returns:
      The status of the validation.
      See Also:

    • 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, validationStatus will return ValidationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from validationStatusAsString().

      Returns:
      The status of the validation.
      See Also:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<OperationEvent.Builder,OperationEvent>
      Returns:
      a builder for type T

    • builder

      public static OperationEvent.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OperationEvent.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.