co.cask.cdap.etl.api.batch

Interface BatchSinkContext

All Superinterfaces:

BatchContext, DatasetContext, LookupProvider, StageContext, TransformContext

@Beta
public interface BatchSinkContext
extends BatchContext

Context of a Batch Sink.

Method Summary

Methods

Modifier and Type	Method and Description
void	addOutput(Output output) Updates the output configuration of this job to also allow writing using the given output.
void	addOutput(String datasetName) Deprecated. Deprecated since 3.4.0. Use addOutput(Output) instead
void	addOutput(String datasetName, Map<String,String> arguments) Deprecated. Deprecated since 3.4.0. Use addOutput(Output) instead
void	addOutput(String outputName, OutputFormatProvider outputFormatProvider) Deprecated. Deprecated since 3.4.0. Use addOutput(Output) instead

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

createDataset, datasetExists, getHadoopJob, getLogicalStartTime, getRuntimeArguments, setRuntimeArgument

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

getMetrics, getPluginProperties, getPluginProperties, getStageName, loadPluginClass, newPluginInstance

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

provide

Method Detail

addOutput

@Deprecated
void addOutput(String datasetName)

Deprecated. Deprecated since 3.4.0. Use addOutput(Output) instead

Overrides the output configuration of this job to also allow writing to the specified dataset by its name.

Parameters:

datasetName - the name of the output dataset

addOutput

@Deprecated
void addOutput(String datasetName,
                        Map<String,String> arguments)

Deprecated. Deprecated since 3.4.0. Use addOutput(Output) instead

Updates the output configuration of this job to also allow writing to the specified dataset. Currently, the dataset specified in must be an OutputFormatProvider. You may want to use this method instead of addOutput(String) if your output dataset uses runtime arguments set in your own program logic.

Parameters:

datasetName - the name of the output dataset

arguments - the arguments to use when instantiating the dataset

Throws:

IllegalArgumentException - if the specified dataset is not an OutputFormatProvider.

addOutput

@Deprecated
void addOutput(String outputName,
                        OutputFormatProvider outputFormatProvider)

Deprecated. Deprecated since 3.4.0. Use addOutput(Output) instead

Updates the output configuration of this job to also allow writing using the given OutputFormatProvider.

Parameters:

outputName - the name of the output

outputFormatProvider - the outputFormatProvider which specifies an OutputFormat and configuration to be used when writing to this output

addOutput

void addOutput(Output output)

Updates the output configuration of this job to also allow writing using the given output.

Parameters:

output - output to be used