io.cdap.cdap.api.workflow

Interface WorkflowConfigurer

All Superinterfaces:

DatasetConfigurer, FeatureFlagsProvider, PluginConfigurer, ProgramConfigurer

public interface WorkflowConfigurer
extends ProgramConfigurer, PluginConfigurer, DatasetConfigurer

Configurer for configuring the Workflow.

Method Summary

Modifier and Type	Method and Description
void	addAction(CustomAction action) Adds a custom action as a next sequential step in the Workflow
void	addMapReduce(String mapReduce) Adds a MapReduce program as a next sequential step in the Workflow.
void	addSpark(String spark) Adds a Spark program as a next sequential step in the Workflow.
WorkflowConditionConfigurer<? extends WorkflowConfigurer>	condition(Condition condition) Adds a condition to the Workflow.
WorkflowConditionConfigurer<? extends WorkflowConfigurer>	condition(Predicate<WorkflowContext> condition) Adds a condition to the Workflow.
void	createLocalDataset(String datasetName, Class<? extends Dataset> datasetClass, DatasetProperties props) Adds a local dataset instance to the Workflow.
void	createLocalDataset(String datasetName, String typeName, DatasetProperties properties) Adds a local dataset instance to the Workflow.
WorkflowForkConfigurer<? extends WorkflowConfigurer>	fork() Forks the execution of the Workflow into multiple branches

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

setDescription, setName, setProperties

Methods inherited from interface io.cdap.cdap.api.feature.FeatureFlagsProvider

isFeatureEnabled

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

evaluateMacros, evaluateMacros, usePlugin, usePlugin, usePluginClass, usePluginClass

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

addDatasetModule, addDatasetType, createDataset, createDataset, createDataset, createDataset

Method Detail

addMapReduce

void addMapReduce(String mapReduce)

Adds a MapReduce program as a next sequential step in the Workflow. MapReduce program must be configured when the Application is defined. Application deployment will fail if the MapReduce program does not exist.

Parameters:

mapReduce - name of the MapReduce program to be added to the Workflow

addSpark

void addSpark(String spark)

Adds a Spark program as a next sequential step in the Workflow. Spark program must be configured when the Application is defined. Application deployment will fail if the Spark program does not exist.

Parameters:

spark - name of the Spark program to be added to the Workflow

addAction

void addAction(CustomAction action)

Adds a custom action as a next sequential step in the Workflow

Parameters:

action - to be added to the Workflow

fork

WorkflowForkConfigurer<? extends WorkflowConfigurer> fork()

Forks the execution of the Workflow into multiple branches

Returns:

the configurer for the Workflow

condition

WorkflowConditionConfigurer<? extends WorkflowConfigurer> condition(Predicate<WorkflowContext> condition)

Adds a condition to the Workflow.

Parameters:

condition - the Predicate to be evaluated for the condition

Returns:

the configurer for the condition

condition

WorkflowConditionConfigurer<? extends WorkflowConfigurer> condition(Condition condition)

Adds a condition to the Workflow.

Parameters:

condition - the Condition to be evaluated

Returns:

the configurer for the condition

createLocalDataset

@Beta
void createLocalDataset(String datasetName,
                              String typeName,
                              DatasetProperties properties)

Adds a local dataset instance to the Workflow.

Local datasets are created at the start of every Workflow run and deleted once the run is complete. User can decide to keep the local datasets even after the run is complete by specifying the runtime arguments - dataset.dataset_name.keep.local=true.

Parameters:

datasetName - name of the dataset instance

typeName - name of the dataset type

properties - dataset instance properties

createLocalDataset

@Beta
void createLocalDataset(String datasetName,
                              Class<? extends Dataset> datasetClass,
                              DatasetProperties props)

Adds a local dataset instance to the Workflow. Also deploys the dataset type represented by the datasetClass parameter in the current namespace.

Local datasets are created at the start of every Workflow run and deleted once the run is complete. User can decide to keep the local datasets even after the run is complete by specifying the runtime arguments - dataset.dataset_name.keep.local=true.

Parameters:

datasetName - dataset instance name

datasetClass - dataset class to create the Dataset type from

props - dataset instance properties