co.cask.cdap.etl.api.batch

Class BatchConfigurable<T extends BatchContext>

java.lang.Object

co.cask.cdap.etl.api.batch.BatchConfigurable<T>

Type Parameters:

T - batch execution context

All Implemented Interfaces:

PipelineConfigurable

Direct Known Subclasses:

BatchAggregator, BatchSink, BatchSource

@Beta
public abstract class BatchConfigurable<T extends BatchContext>
extends Object
implements PipelineConfigurable

Base class for Batch run configuration methods.

Constructor Summary

Constructors

Constructor and Description
BatchConfigurable()

Method Summary

Methods

Modifier and Type	Method and Description
void	configurePipeline(PipelineConfigurer pipelineConfigurer) Configure an ETL pipeline, adding datasets and streams that the stage needs.
void	onRunFinish(boolean succeeded, T context) Invoked after the Batch run finishes.
abstract void	prepareRun(T context) Prepare the Batch run.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchConfigurable

public BatchConfigurable()

Method Detail

configurePipeline

public void configurePipeline(PipelineConfigurer pipelineConfigurer)

Description copied from interface: PipelineConfigurable

Configure an ETL pipeline, adding datasets and streams that the stage needs.

Specified by:

configurePipeline in interface PipelineConfigurable

Parameters:

pipelineConfigurer - the configurer used to add required datasets and streams

prepareRun

public abstract void prepareRun(T context)
                         throws Exception

Prepare the Batch run. Used to configure the job before starting the run.

Parameters:

context - batch execution context

Throws:

Exception - if there's an error during this method invocation

onRunFinish

public void onRunFinish(boolean succeeded,
               T context)

Invoked after the Batch run finishes. Used to perform any end of the run logic.

Parameters:

succeeded - defines the result of batch execution: true if run succeeded, false otherwise

context - batch execution context