Class WorkflowRun
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WorkflowRun.Builder,
WorkflowRun>
A workflow run is an execution of a workflow providing all the runtime information.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic WorkflowRun.Builder
builder()
final Instant
The date and time when the workflow run completed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
This error message describes any error that may have occurred in starting the workflow run.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final WorkflowGraph
graph()
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the WorkflowRunProperties property.final String
name()
Name of the workflow that was run.final String
The ID of the previous workflow run.static Class
<? extends WorkflowRun.Builder> final Instant
The date and time when the workflow run was started.The batch condition that started the workflow run.final WorkflowRunStatistics
The statistics of the run.final WorkflowRunStatus
status()
The status of the workflow run.final String
The status of the workflow run.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The ID of this workflow run.The workflow run properties which were set during the run.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
Name of the workflow that was run.
- Returns:
- Name of the workflow that was run.
-
workflowRunId
The ID of this workflow run.
- Returns:
- The ID of this workflow run.
-
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 theisEmpty()
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
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
The date and time when the workflow run was started.
- Returns:
- The date and time when the workflow run was started.
-
completedOn
The date and time when the workflow run completed.
- Returns:
- The date and time when the workflow run completed.
-
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 returnWorkflowRunStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the workflow run.
- See Also:
-
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 returnWorkflowRunStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the workflow run.
- See Also:
-
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
The statistics of the run.
- Returns:
- The statistics of the run.
-
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
The batch condition that started the workflow run.
- Returns:
- The batch condition that started the workflow run.
-
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 interfaceToCopyableBuilder<WorkflowRun.Builder,
WorkflowRun> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-