Class ExecutionEvent

java.lang.Object
software.amazon.awssdk.services.arcregionswitch.model.ExecutionEvent
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ExecutionEvent.Builder,ExecutionEvent>
@Generated("software.amazon.awssdk:codegen") public final class ExecutionEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExecutionEvent.Builder,ExecutionEvent>

Represents an event that occurred during a plan execution. These events provide a detailed timeline of the execution process.

See Also:

  • Method Details

    • timestamp

      public final Instant timestamp()

      The timestamp for an execution event.

      Returns:
      The timestamp for an execution event.

    • type

      public final ExecutionEventType type()

      The type of an execution event.

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

      Returns:
      The type of an execution event.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of an execution event.

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

      Returns:
      The type of an execution event.
      See Also:

    • stepName

      public final String stepName()

      The step name for an execution event.

      Returns:
      The step name for an execution event.

    • executionBlockType

      public final ExecutionBlockType executionBlockType()

      The execution block type for an execution event.

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

      Returns:
      The execution block type for an execution event.
      See Also:

    • executionBlockTypeAsString

      public final String executionBlockTypeAsString()

      The execution block type for an execution event.

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

      Returns:
      The execution block type for an execution event.
      See Also:

    • hasResources

      public final boolean hasResources()
      For responses, this returns true if the service returned a value for the Resources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • resources

      public final List<String> resources()

      The resources for an execution event.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResources() method.

      Returns:
      The resources for an execution event.

    • error

      public final String error()

      Errors for an execution event.

      Returns:
      Errors for an execution event.

    • description

      public final String description()

      The description for an execution event.

      Returns:
      The description for an execution event.

    • eventId

      public final String eventId()

      The event ID for an execution event.

      Returns:
      The event ID for an execution event.

    • previousEventId

      public final String previousEventId()

      The event ID of the previous execution event.

      Returns:
      The event ID of the previous execution event.

    • toBuilder

      public ExecutionEvent.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<ExecutionEvent.Builder,ExecutionEvent>
      Returns:
      a builder for type T

    • builder

      public static ExecutionEvent.Builder builder()

    • serializableBuilderClass

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