co.cask.cdap.etl.api.batch

Interface BatchActionContext

All Superinterfaces:

BatchRuntimeContext, DatasetContext, LookupProvider, ServiceDiscoverer, StageContext, TransformContext

@Beta
public interface BatchActionContext
extends BatchRuntimeContext

Context for a batch action, giving access to whether the run was successful, the workflow token, and the state of each phase in the workflow. This API is marked as beta and subject to change.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,WorkflowNodeState>	getNodeStates() Return an immutable Map of node ids to WorkflowNodeState.
WorkflowToken	getToken()
boolean	isSuccessful() Return true if the execution was successful, false otherwise.

Methods inherited from interface co.cask.cdap.etl.api.batch.BatchRuntimeContext

getHadoopJob, getLogicalStartTime, getRuntimeArguments

Methods inherited from interface co.cask.cdap.api.data.DatasetContext

discardDataset, getDataset, getDataset, getDataset, getDataset, releaseDataset

Methods inherited from interface co.cask.cdap.etl.api.StageContext

getInputSchema, getInputSchemas, getMetrics, getOutputSchema, getPluginProperties, getPluginProperties, getStageName, loadPluginClass, newPluginInstance

Methods inherited from interface co.cask.cdap.api.ServiceDiscoverer

getServiceURL, getServiceURL

Methods inherited from interface co.cask.cdap.etl.api.LookupProvider

provide

Method Detail

getToken

WorkflowToken getToken()

Returns:

a WorkflowToken

getNodeStates

Map<String,WorkflowNodeState> getNodeStates()

Return an immutable Map of node ids to WorkflowNodeState. This can be used to determine the status of all pipeline phases executed in the current run.

isSuccessful

boolean isSuccessful()

Return true if the execution was successful, false otherwise. This method can be used to determine the status of the pipeline run.