WorkflowRun (AWS Java SDK :: Services :: AWS Glue 2.15.32 API)

java.lang.Object
- software.amazon.awssdk.services.glue.model.WorkflowRun

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkflowRun.Builder,WorkflowRun>
```
@Generated(value="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 and Description

static interface WorkflowRun.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`WorkflowRun.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static WorkflowRun.Builder`	`builder()`
`Instant`	`completedOn()` The date and time when the workflow run completed.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`errorMessage()` This error message describes any error that may have occurred in starting the workflow run.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`WorkflowGraph`	`graph()` The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.
`int`	`hashCode()`
`boolean`	`hasWorkflowRunProperties()` Returns true if the WorkflowRunProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`name()` Name of the workflow that was executed.
`String`	`previousRunId()` The ID of the previous workflow run.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WorkflowRun.Builder>`	`serializableBuilderClass()`
`Instant`	`startedOn()` The date and time when the workflow run was started.
`WorkflowRunStatistics`	`statistics()` The statistics of the run.
`WorkflowRunStatus`	`status()` The status of the workflow run.
`String`	`statusAsString()` The status of the workflow run.
`WorkflowRun.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`workflowRunId()` 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 String name()
```
    Name of the workflow that was executed.
    
    Returns:
    
    Name of the workflow that was executed.
  - workflowRunId
```
public String workflowRunId()
```
    The ID of this workflow run.
    
    Returns:
    
    The ID of this workflow run.
  - previousRunId
```
public String previousRunId()
```
    The ID of the previous workflow run.
    
    Returns:
    
    The ID of the previous workflow run.
  - hasWorkflowRunProperties
```
public boolean hasWorkflowRunProperties()
```
    Returns true if the WorkflowRunProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - workflowRunProperties
```
public 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.
    
    You can use hasWorkflowRunProperties() to see if a value was sent in this field.
    
    Returns:
    
    The workflow run properties which were set during the run.
  - startedOn
```
public 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 Instant completedOn()
```
    The date and time when the workflow run completed.
    
    Returns:
    
    The date and time when the workflow run completed.
  - status
```
public 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:
    
    WorkflowRunStatus
  - statusAsString
```
public 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:
    
    WorkflowRunStatus
  - errorMessage
```
public 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 WorkflowRunStatistics statistics()
```
    The statistics of the run.
    
    Returns:
    
    The statistics of the run.
  - graph
```
public WorkflowGraph graph()
```
    The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.
    
    Returns:
    
    The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.
  - toBuilder
```
public WorkflowRun.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WorkflowRun.Builder,WorkflowRun>
  - builder
```
public static WorkflowRun.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WorkflowRun.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class WorkflowRun

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

workflowRunId

previousRunId

hasWorkflowRunProperties

workflowRunProperties

startedOn

completedOn

status

statusAsString

errorMessage

statistics

graph

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields