io.cdap.cdap.api.workflow

Interface WorkflowContext

All Superinterfaces:

DatasetContext, LineageRecorder, MessagingContext, MetadataReader, MetadataWriter, PluginContext, RuntimeContext, SchedulableProgramContext, SecureStore, ServiceDiscoverer, Transactional

public interface WorkflowContext
extends SchedulableProgramContext, RuntimeContext, Transactional, MessagingContext, ServiceDiscoverer, DatasetContext, PluginContext, SecureStore, LineageRecorder, MetadataReader, MetadataWriter

Represents the runtime context of a Workflow. This context is also available to Condition.

Method Summary

Modifier and Type	Method and Description
void	enableFieldLineageConsolidation() Call this method to consolidate the field lineage operations at Workflow level, rather than emitting them from nodes running inside the Workflow.
ConditionSpecification	getConditionSpecification() Returns ConditionSpecification associated with the condition node in the Workflow.
long	getLogicalStartTime()
Map<String,WorkflowNodeState>	getNodeStates() Return an immutable Map of node ids to WorkflowNodeState.
ProgramState	getState() Return the state of the workflow.
WorkflowToken	getToken()
WorkflowSpecification	getWorkflowSpecification()

Methods inherited from interface io.cdap.cdap.api.SchedulableProgramContext

getTriggeringScheduleInfo

Methods inherited from interface io.cdap.cdap.api.RuntimeContext

getAdmin, getApplicationSpecification, getClusterName, getDataTracer, getNamespace, getRunId, getRuntimeArguments

Methods inherited from interface io.cdap.cdap.api.Transactional

execute, execute

Methods inherited from interface io.cdap.cdap.api.messaging.MessagingContext

getDirectMessagePublisher, getMessageFetcher, getMessagePublisher

Methods inherited from interface io.cdap.cdap.api.ServiceDiscoverer

getServiceURL, getServiceURL, getServiceURL

Methods inherited from interface io.cdap.cdap.api.data.DatasetContext

discardDataset, getDataset, getDataset, getDataset, getDataset, releaseDataset

Methods inherited from interface io.cdap.cdap.api.plugin.PluginContext

getPluginProperties, getPluginProperties, loadPluginClass, newPluginInstance, newPluginInstance

Methods inherited from interface io.cdap.cdap.api.security.store.SecureStore

get, list

Methods inherited from interface io.cdap.cdap.api.lineage.field.LineageRecorder

flushLineage, record

Methods inherited from interface io.cdap.cdap.api.metadata.MetadataReader

getMetadata, getMetadata

Methods inherited from interface io.cdap.cdap.api.metadata.MetadataWriter

addProperties, addTags, addTags, removeMetadata, removeProperties, removeProperties, removeTags, removeTags

Method Detail

getWorkflowSpecification

WorkflowSpecification getWorkflowSpecification()

getConditionSpecification

ConditionSpecification getConditionSpecification()

Returns ConditionSpecification associated with the condition node in the Workflow.

Throws:

UnsupportedOperationException - if it is not called from Predicate or Condition

getLogicalStartTime

long getLogicalStartTime()

getToken

WorkflowToken getToken()

Returns:

a WorkflowToken

getNodeStates

@Beta
Map<String,WorkflowNodeState> getNodeStates()

Return an immutable Map of node ids to WorkflowNodeState. This can be used from AbstractWorkflow.destroy() method to determine the status of all nodes executed by the Workflow in the current run.

getState

@Beta
ProgramState getState()

Return the state of the workflow. This method can be used from AbstractWorkflow.destroy() to determine the status of the Workflow.

Returns:

a ProgramState

enableFieldLineageConsolidation

@Beta
void enableFieldLineageConsolidation()

Call this method to consolidate the field lineage operations at Workflow level, rather than emitting them from nodes running inside the Workflow. This method should be called from AbstractWorkflow.initialize(io.cdap.cdap.api.workflow.WorkflowContext) method at which point no node has been executed yet. Calling this method means Workflow is taking responsibility of emitting the field operations. In AbstractWorkflow.destroy() method of the Workflow, field operations will be available as WorkflowNodeState by calling getNodeStates() method. If workflow does not call LineageRecorder.record(java.util.Collection<? extends io.cdap.cdap.api.lineage.field.Operation>) method, then no field lineage will be emitted.