Class OperationEvent

    • 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.
      • 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:
        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.
      • 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:
        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, 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:
        HookStatus
      • hookStatusReason

        public final String hookStatusReason()

        Additional information about the Hook status.

        Returns:
        Additional information about the Hook status.
      • 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:
        HookInvocationPoint
      • 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:
        HookFailureMode
      • 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:
        DetailedStatus
      • 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:
        HookFailureMode
      • validationName

        public final String validationName()

        The name of the validation that was performed.

        Returns:
        The name of the validation that was performed.
      • 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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)