io.cdap.cdap.etl.api.action

Class Action

java.lang.Object

io.cdap.cdap.etl.api.action.Action

All Implemented Interfaces:

PipelineConfigurable

public abstract class Action
extends Object
implements PipelineConfigurable

Represents custom logic to be executed in the pipeline.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_TYPE

Constructor Summary

Constructors

Constructor and Description
Action()

Method Summary

Modifier and Type	Method and Description
void	configurePipeline(PipelineConfigurer pipelineConfigurer) Configure an ETL pipeline, registering datasets and plugins that the stage needs.
abstract void	run(ActionContext context) Implement this method to execute the code as a part of action run.

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_TYPE

public static final String PLUGIN_TYPE

See Also:

Constant Field Values

Constructor Detail

Action

public Action()

Method Detail

run

public abstract void run(ActionContext context)
                  throws Exception

Implement this method to execute the code as a part of action run.

Parameters:

context - the action context, containing information about the pipeline run

Throws:

Exception - when there is failure in method execution

configurePipeline

public void configurePipeline(PipelineConfigurer pipelineConfigurer)

Description copied from interface: PipelineConfigurable

Configure an ETL pipeline, registering datasets and plugins that the stage needs. Validation should be performed in this method, throwing a ValidationException if there are any invalid config properties, or if the input or output schema is not compatible. Output schema should also be set. This method is called many times during the lifecycle of a pipeline so it should not generate any side effects. When the pipeline is being constructed, this is called in order to validate the pipeline and propagate schema. Any datasets registered at this time will be ignored. Config properties that contain macros will not have been evaluated yet. When the pipeline is deployed, this is called in order to validate the pipeline and create any datasets that are registered. Config properties that contain macros will not have been evaluated yet.

Specified by:

configurePipeline in interface PipelineConfigurable

Parameters:

pipelineConfigurer - the configurer used to register required datasets and plugins