WorkflowRun (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.glue.model.WorkflowRun

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WorkflowRun
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A workflow run is an execution of a workflow providing all the runtime information.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkflowRun()

Constructors
Constructor and Description
`WorkflowRun()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkflowRun`	`addWorkflowRunPropertiesEntry(String key, String value)` Add a single WorkflowRunProperties entry
`WorkflowRun`	`clearWorkflowRunPropertiesEntries()` Removes all the entries added into WorkflowRunProperties.
`WorkflowRun`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCompletedOn()` The date and time when the workflow run completed.
`String`	`getErrorMessage()` This error message describes any error that may have occurred in starting the workflow run.
`WorkflowGraph`	`getGraph()` The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
`String`	`getName()` Name of the workflow that was run.
`String`	`getPreviousRunId()` The ID of the previous workflow run.
`Date`	`getStartedOn()` The date and time when the workflow run was started.
`StartingEventBatchCondition`	`getStartingEventBatchCondition()` The batch condition that started the workflow run.
`WorkflowRunStatistics`	`getStatistics()` The statistics of the run.
`String`	`getStatus()` The status of the workflow run.
`String`	`getWorkflowRunId()` The ID of this workflow run.
`Map<String,String>`	`getWorkflowRunProperties()` The workflow run properties which were set during the run.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCompletedOn(Date completedOn)` The date and time when the workflow run completed.
`void`	`setErrorMessage(String errorMessage)` This error message describes any error that may have occurred in starting the workflow run.
`void`	`setGraph(WorkflowGraph graph)` The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
`void`	`setName(String name)` Name of the workflow that was run.
`void`	`setPreviousRunId(String previousRunId)` The ID of the previous workflow run.
`void`	`setStartedOn(Date startedOn)` The date and time when the workflow run was started.
`void`	`setStartingEventBatchCondition(StartingEventBatchCondition startingEventBatchCondition)` The batch condition that started the workflow run.
`void`	`setStatistics(WorkflowRunStatistics statistics)` The statistics of the run.
`void`	`setStatus(String status)` The status of the workflow run.
`void`	`setWorkflowRunId(String workflowRunId)` The ID of this workflow run.
`void`	`setWorkflowRunProperties(Map<String,String> workflowRunProperties)` The workflow run properties which were set during the run.
`String`	`toString()` Returns a string representation of this object.
`WorkflowRun`	`withCompletedOn(Date completedOn)` The date and time when the workflow run completed.
`WorkflowRun`	`withErrorMessage(String errorMessage)` This error message describes any error that may have occurred in starting the workflow run.
`WorkflowRun`	`withGraph(WorkflowGraph graph)` The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
`WorkflowRun`	`withName(String name)` Name of the workflow that was run.
`WorkflowRun`	`withPreviousRunId(String previousRunId)` The ID of the previous workflow run.
`WorkflowRun`	`withStartedOn(Date startedOn)` The date and time when the workflow run was started.
`WorkflowRun`	`withStartingEventBatchCondition(StartingEventBatchCondition startingEventBatchCondition)` The batch condition that started the workflow run.
`WorkflowRun`	`withStatistics(WorkflowRunStatistics statistics)` The statistics of the run.
`WorkflowRun`	`withStatus(String status)` The status of the workflow run.
`WorkflowRun`	`withStatus(WorkflowRunStatus status)` The status of the workflow run.
`WorkflowRun`	`withWorkflowRunId(String workflowRunId)` The ID of this workflow run.
`WorkflowRun`	`withWorkflowRunProperties(Map<String,String> workflowRunProperties)` The workflow run properties which were set during the run.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WorkflowRun
```
public WorkflowRun()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    Name of the workflow that was run.
    
    Parameters:
    
    name - Name of the workflow that was run.
  - getName
```
public String getName()
```
    Name of the workflow that was run.
    
    Returns:
    
    Name of the workflow that was run.
  - withName
```
public WorkflowRun withName(String name)
```
    Name of the workflow that was run.
    
    Parameters:
    
    name - Name of the workflow that was run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorkflowRunId
```
public void setWorkflowRunId(String workflowRunId)
```
    The ID of this workflow run.
    
    Parameters:
    
    workflowRunId - The ID of this workflow run.
  - getWorkflowRunId
```
public String getWorkflowRunId()
```
    The ID of this workflow run.
    
    Returns:
    
    The ID of this workflow run.
  - withWorkflowRunId
```
public WorkflowRun withWorkflowRunId(String workflowRunId)
```
    The ID of this workflow run.
    
    Parameters:
    
    workflowRunId - The ID of this workflow run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreviousRunId
```
public void setPreviousRunId(String previousRunId)
```
    The ID of the previous workflow run.
    
    Parameters:
    
    previousRunId - The ID of the previous workflow run.
  - getPreviousRunId
```
public String getPreviousRunId()
```
    The ID of the previous workflow run.
    
    Returns:
    
    The ID of the previous workflow run.
  - withPreviousRunId
```
public WorkflowRun withPreviousRunId(String previousRunId)
```
    The ID of the previous workflow run.
    
    Parameters:
    
    previousRunId - The ID of the previous workflow run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getWorkflowRunProperties
```
public Map<String,String> getWorkflowRunProperties()
```
    The workflow run properties which were set during the run.
    
    Returns:
    
    The workflow run properties which were set during the run.
  - setWorkflowRunProperties
```
public void setWorkflowRunProperties(Map<String,String> workflowRunProperties)
```
    The workflow run properties which were set during the run.
    
    Parameters:
    
    workflowRunProperties - The workflow run properties which were set during the run.
  - withWorkflowRunProperties
```
public WorkflowRun withWorkflowRunProperties(Map<String,String> workflowRunProperties)
```
    The workflow run properties which were set during the run.
    
    Parameters:
    
    workflowRunProperties - The workflow run properties which were set during the run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addWorkflowRunPropertiesEntry
```
public WorkflowRun addWorkflowRunPropertiesEntry(String key,
                                                 String value)
```
    Add a single WorkflowRunProperties entry
    
    See Also:
    
    withWorkflowRunProperties(java.util.Map<java.lang.String, java.lang.String>)
  - clearWorkflowRunPropertiesEntries
```
public WorkflowRun clearWorkflowRunPropertiesEntries()
```
    Removes all the entries added into WorkflowRunProperties.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartedOn
```
public void setStartedOn(Date startedOn)
```
    The date and time when the workflow run was started.
    
    Parameters:
    
    startedOn - The date and time when the workflow run was started.
  - getStartedOn
```
public Date getStartedOn()
```
    The date and time when the workflow run was started.
    
    Returns:
    
    The date and time when the workflow run was started.
  - withStartedOn
```
public WorkflowRun withStartedOn(Date startedOn)
```
    The date and time when the workflow run was started.
    
    Parameters:
    
    startedOn - The date and time when the workflow run was started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletedOn
```
public void setCompletedOn(Date completedOn)
```
    The date and time when the workflow run completed.
    
    Parameters:
    
    completedOn - The date and time when the workflow run completed.
  - getCompletedOn
```
public Date getCompletedOn()
```
    The date and time when the workflow run completed.
    
    Returns:
    
    The date and time when the workflow run completed.
  - withCompletedOn
```
public WorkflowRun withCompletedOn(Date completedOn)
```
    The date and time when the workflow run completed.
    
    Parameters:
    
    completedOn - The date and time when the workflow run completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the workflow run.
    
    Parameters:
    
    status - The status of the workflow run.
    
    See Also:
    
    WorkflowRunStatus
  - getStatus
```
public String getStatus()
```
    The status of the workflow run.
    
    Returns:
    
    The status of the workflow run.
    
    See Also:
    
    WorkflowRunStatus
  - withStatus
```
public WorkflowRun withStatus(String status)
```
    The status of the workflow run.
    
    Parameters:
    
    status - The status of the workflow run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkflowRunStatus
  - withStatus
```
public WorkflowRun withStatus(WorkflowRunStatus status)
```
    The status of the workflow run.
    
    Parameters:
    
    status - The status of the workflow run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkflowRunStatus
  - setErrorMessage
```
public void setErrorMessage(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."
    
    Parameters:
    
    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."
  - getErrorMessage
```
public String getErrorMessage()
```
    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."
  - withErrorMessage
```
public WorkflowRun withErrorMessage(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."
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatistics
```
public void setStatistics(WorkflowRunStatistics statistics)
```
    The statistics of the run.
    
    Parameters:
    
    statistics - The statistics of the run.
  - getStatistics
```
public WorkflowRunStatistics getStatistics()
```
    The statistics of the run.
    
    Returns:
    
    The statistics of the run.
  - withStatistics
```
public WorkflowRun withStatistics(WorkflowRunStatistics statistics)
```
    The statistics of the run.
    
    Parameters:
    
    statistics - The statistics of the run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGraph
```
public void setGraph(WorkflowGraph graph)
```
    The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
    
    Parameters:
    
    graph - The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
  - getGraph
```
public WorkflowGraph getGraph()
```
    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.
  - withGraph
```
public WorkflowRun withGraph(WorkflowGraph graph)
```
    The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
    
    Parameters:
    
    graph - The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartingEventBatchCondition
```
public void setStartingEventBatchCondition(StartingEventBatchCondition startingEventBatchCondition)
```
    The batch condition that started the workflow run.
    
    Parameters:
    
    startingEventBatchCondition - The batch condition that started the workflow run.
  - getStartingEventBatchCondition
```
public StartingEventBatchCondition getStartingEventBatchCondition()
```
    The batch condition that started the workflow run.
    
    Returns:
    
    The batch condition that started the workflow run.
  - withStartingEventBatchCondition
```
public WorkflowRun withStartingEventBatchCondition(StartingEventBatchCondition startingEventBatchCondition)
```
    The batch condition that started the workflow run.
    
    Parameters:
    
    startingEventBatchCondition - The batch condition that started the workflow run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public WorkflowRun clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class WorkflowRun

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkflowRun

Method Detail

setName

getName

withName

setWorkflowRunId

getWorkflowRunId

withWorkflowRunId

setPreviousRunId

getPreviousRunId

withPreviousRunId

getWorkflowRunProperties

setWorkflowRunProperties

withWorkflowRunProperties

addWorkflowRunPropertiesEntry

clearWorkflowRunPropertiesEntries

setStartedOn

getStartedOn

withStartedOn

setCompletedOn

getCompletedOn

withCompletedOn

setStatus

getStatus

withStatus

withStatus

setErrorMessage

getErrorMessage

withErrorMessage

setStatistics

getStatistics

withStatistics

setGraph

getGraph

withGraph

setStartingEventBatchCondition

getStartingEventBatchCondition

withStartingEventBatchCondition

toString

equals

hashCode

clone

marshall