Class WorkflowRunDetail

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

Detailed information about a workflow run execution, including timing, status, error information, and associated task instances. This structure provides comprehensive visibility into the workflow execution lifecycle within the Amazon Managed Workflows for Apache Airflow Serverless serverless environment. The service tracks execution across distributed ECS worker tasks and provides detailed timing information, error diagnostics, and task instance relationships to support effective monitoring and troubleshooting of complex workflow executions.

See Also:

  • Method Details

    • workflowArn

      public final String workflowArn()

      The Amazon Resource Name (ARN) of the workflow that contains this run.

      Returns:
      The Amazon Resource Name (ARN) of the workflow that contains this run.

    • workflowVersion

      public final String workflowVersion()

      The version of the workflow used for this run.

      Returns:
      The version of the workflow used for this run.

    • runId

      public final String runId()

      The unique identifier of this workflow run.

      Returns:
      The unique identifier of this workflow run.

    • runType

      public final RunType runType()

      The type of workflow run.

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

      Returns:
      The type of workflow run.
      See Also:

    • runTypeAsString

      public final String runTypeAsString()

      The type of workflow run.

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

      Returns:
      The type of workflow run.
      See Also:

    • startedOn

      public final Instant startedOn()

      The timestamp when the workflow run started execution, in ISO 8601 date-time format.

      Returns:
      The timestamp when the workflow run started execution, in ISO 8601 date-time format.

    • createdAt

      public final Instant createdAt()

      The timestamp when the workflow run was created, in ISO 8601 date-time format.

      Returns:
      The timestamp when the workflow run was created, in ISO 8601 date-time format.

    • completedOn

      public final Instant completedOn()

      The timestamp when the workflow run completed execution, in ISO 8601 date-time format. This value is null if the run is not complete.

      Returns:
      The timestamp when the workflow run completed execution, in ISO 8601 date-time format. This value is null if the run is not complete.

    • modifiedAt

      public final Instant modifiedAt()

      The timestamp when the workflow run was last modified, in ISO 8601 date-time format.

      Returns:
      The timestamp when the workflow run was last modified, in ISO 8601 date-time format.

    • duration

      public final Integer duration()

      The total duration of the workflow run execution in seconds. This value is null if the run is not complete.

      Returns:
      The total duration of the workflow run execution in seconds. This value is null if the run is not complete.

    • errorMessage

      public final String errorMessage()

      The error message if the workflow run failed. This value is null if the run completed successfully.

      Returns:
      The error message if the workflow run failed. This value is null if the run completed successfully.

    • hasTaskInstances

      public final boolean hasTaskInstances()
      For responses, this returns true if the service returned a value for the TaskInstances 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.

    • taskInstances

      public final List<String> taskInstances()

      A list of task instance IDs that are part of this workflow run.

      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 hasTaskInstances() method.

      Returns:
      A list of task instance IDs that are part of this workflow run.

    • runState

      public final WorkflowRunStatus runState()

      The current execution state of the workflow run.

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

      Returns:
      The current execution state of the workflow run.
      See Also:

    • runStateAsString

      public final String runStateAsString()

      The current execution state of the workflow run.

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

      Returns:
      The current execution state of the workflow run.
      See Also:

    • toBuilder

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

    • builder

      public static WorkflowRunDetail.Builder builder()

    • serializableBuilderClass

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