Class WorkflowRun

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

A workflow run is an execution of a workflow providing all the runtime information.

See Also:

  • Method Details

    • name

      public final String name()

      Name of the workflow that was run.

      Returns:
      Name of the workflow that was run.

    • workflowRunId

      public final String workflowRunId()

      The ID of this workflow run.

      Returns:
      The ID of this workflow run.

    • previousRunId

      public final String previousRunId()

      The ID of the previous workflow run.

      Returns:
      The ID of the previous workflow run.

    • hasWorkflowRunProperties

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

    • workflowRunProperties

      public final Map<String,String> workflowRunProperties()

      The workflow run properties which were set during the 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 hasWorkflowRunProperties() method.

      Returns:
      The workflow run properties which were set during the run.

    • startedOn

      public final Instant startedOn()

      The date and time when the workflow run was started.

      Returns:
      The date and time when the workflow run was started.

    • completedOn

      public final Instant completedOn()

      The date and time when the workflow run completed.

      Returns:
      The date and time when the workflow run completed.

    • status

      public final WorkflowRunStatus status()

      The status of the workflow run.

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

      Returns:
      The status of the workflow run.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the workflow run.

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

      Returns:
      The status of the workflow run.
      See Also:

    • errorMessage

      public final String errorMessage()

      This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."

      Returns:
      This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."

    • statistics

      public final WorkflowRunStatistics statistics()

      The statistics of the run.

      Returns:
      The statistics of the run.

    • graph

      public final WorkflowGraph graph()

      The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.

      Returns:
      The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.

    • startingEventBatchCondition

      public final StartingEventBatchCondition startingEventBatchCondition()

      The batch condition that started the workflow run.

      Returns:
      The batch condition that started the workflow run.

    • toBuilder

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

    • builder

      public static WorkflowRun.Builder builder()

    • serializableBuilderClass

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