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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceWorkflowRun.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static WorkflowRun.Builderbuilder()InstantcompletedOn()The date and time when the workflow run completed.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringerrorMessage()This error message describes any error that may have occurred in starting the workflow run.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)WorkflowGraphgraph()The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.inthashCode()booleanhasWorkflowRunProperties()For responses, this returns true if the service returned a value for the WorkflowRunProperties property.Stringname()Name of the workflow that was run.StringpreviousRunId()The ID of the previous workflow run.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends WorkflowRun.Builder>serializableBuilderClass()InstantstartedOn()The date and time when the workflow run was started.StartingEventBatchConditionstartingEventBatchCondition()The batch condition that started the workflow run.WorkflowRunStatisticsstatistics()The statistics of the run.WorkflowRunStatusstatus()The status of the workflow run.StringstatusAsString()The status of the workflow run.WorkflowRun.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringworkflowRunId()The ID of this workflow run.Map<String,String>workflowRunProperties()The workflow run properties which were set during the run.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 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
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,
statuswill returnWorkflowRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the workflow run.
- See Also:
WorkflowRunStatus
-
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,
statuswill returnWorkflowRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the workflow run.
- See Also:
WorkflowRunStatus
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<WorkflowRun.Builder,WorkflowRun>
-
builder
public static WorkflowRun.Builder builder()
-
serializableBuilderClass
public static Class<? extends WorkflowRun.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-