co.cask.cdap.proto

Class WorkflowNodeStateDetail

java.lang.Object

co.cask.cdap.proto.WorkflowNodeStateDetail

public final class WorkflowNodeStateDetail
extends Object

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

Constructor Summary

Constructors

Constructor and Description
WorkflowNodeStateDetail(String nodeId, NodeStatus nodeStatus) Create a new instance.
WorkflowNodeStateDetail(String nodeId, NodeStatus nodeStatus, String runId, BasicThrowable failureCause) Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
BasicThrowable	getFailureCause() Return the detail message string for failure if node execution failed, otherwise null is returned.
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

WorkflowNodeStateDetail

public WorkflowNodeStateDetail(String nodeId,
                       NodeStatus nodeStatus)

Create a new instance.

Parameters:

nodeId - id of the node inside a Workflow

nodeStatus - status of the node

WorkflowNodeStateDetail

public WorkflowNodeStateDetail(String nodeId,
                       NodeStatus nodeStatus,
                       @Nullable
                       String runId,
                       @Nullable
                       BasicThrowable failureCause)

Create a new instance.

Parameters:

nodeId - id of the node inside a Workflow

nodeStatus - status of the node

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

failureCause - cause of failure, {code 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.

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 BasicThrowable getFailureCause()

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