co.cask.cdap.etl.api.realtime

Class RealtimeSink<I>

java.lang.Object

co.cask.cdap.etl.api.realtime.RealtimeSink<I>

Type Parameters:

I - Type of object that sink operates on

All Implemented Interfaces:

Destroyable, PipelineConfigurable, StageLifecycle<RealtimeContext>

@Beta
public abstract class RealtimeSink<I>
extends Object
implements PipelineConfigurable, StageLifecycle<RealtimeContext>

Realtime Sink.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_TYPE

Constructor Summary

Constructors

Constructor and Description
RealtimeSink()

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	destroy() Destroy the Sink.
void	initialize(RealtimeContext context) Initialize the Sink.
abstract int	write(Iterable<I> objects, DataWriter dataWriter) Write the given objects.

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

RealtimeSink

public RealtimeSink()

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

initialize

public void initialize(RealtimeContext context)
                throws Exception

Initialize the Sink. This method is guaranteed to be invoked before any calls to write(java.lang.Iterable<I>, co.cask.cdap.etl.api.realtime.DataWriter) are made.

Specified by:

initialize in interface StageLifecycle<RealtimeContext>

Parameters:

context - RealtimeContext

Throws:

Exception - if there is any error during initialization

write

public abstract int write(Iterable<I> objects,
        DataWriter dataWriter)
                   throws Exception

Write the given objects.

Parameters:

objects - Iterable of I to write

dataWriter - DataWriter write to CDAP streams and datasets

Returns:

the number of items written. Used by metrics to report how many records written by the sink

Throws:

Exception - if there was some exception writing the objects

destroy

public void destroy()

Destroy the Sink.

Specified by:

destroy in interface Destroyable