io.cdap.cdap.api.workflow

Class WorkflowNodeState

java.lang.Object

io.cdap.cdap.api.workflow.WorkflowNodeState

@Beta
public class WorkflowNodeState
extends Object

Class to represent the state of the node in the Workflow.

Constructor Summary

Constructors

Constructor and Description
WorkflowNodeState(String nodeId, NodeStatus nodeStatus, Set<Operation> fieldLineageOperations, String runId, Throwable failureCause) Create a new instance.
WorkflowNodeState(String nodeId, NodeStatus nodeStatus, String runId, Throwable failureCause) Create a new instance.

Method Summary

Modifier and Type	Method and Description
Throwable	getFailureCause() Return the detail message string for failure if node execution failed, otherwise null is returned.
Set<Operation>	getFieldLineageOperations() Return the field operations recorded by this node.
String	getNodeId() Return the id of the node for which the state is maintained.
NodeStatus	getNodeStatus() Return the status of the node for which the state is maintained.
String	getRunId() Return the run id if node represents programs, such as MapReduce or Spark.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowNodeState

public WorkflowNodeState(String nodeId,
                         NodeStatus nodeStatus,
                         @Nullable
                         String runId,
                         @Nullable
                         Throwable failureCause)

Create a new instance.

Parameters:

nodeId - id of the node inside the Workflow

nodeStatus - status of the node

runId - run id assigned to the node, null if current node represents custom action or predicate

failureCause - cause of failure, null if execution of the node succeeded

WorkflowNodeState

public WorkflowNodeState(String nodeId,
                         NodeStatus nodeStatus,
                         Set<Operation> fieldLineageOperations,
                         @Nullable
                         String runId,
                         @Nullable
                         Throwable failureCause)

Create a new instance.

Parameters:

nodeId - id of the node inside the Workflow

nodeStatus - status of the node

fieldLineageOperations - the set of field operations emitted from this node

runId - run id assigned to the node, null if current node represents custom action or predicate

failureCause - cause of failure, null if execution of the node succeeded

Method Detail

getNodeId

public String getNodeId()

Return the id of the node for which the state is maintained.

getNodeStatus

public NodeStatus getNodeStatus()

Return the status of the node for which the state is maintained.

getFieldLineageOperations

public Set<Operation> getFieldLineageOperations()

Return the field operations recorded by this node. Field operations will only be available for the node if it was ProgramStatus.COMPLETED successfully.

getRunId

@Nullable
public String getRunId()

Return the run id if node represents programs, such as MapReduce or Spark. For custom actions and predicates we do not currently have run id, so method returns null.

getFailureCause

@Nullable
public Throwable getFailureCause()

Return the detail message string for failure if node execution failed, otherwise null is returned.