io.cdap.cdap.etl.api.batch

Interface BatchContext

All Superinterfaces:

DatasetContext, LineageRecorder, LookupProvider, MetadataReader, MetadataWriter, ServiceDiscoverer, StageContext, TransformContext

All Known Subinterfaces:

BatchAggregatorContext, BatchJoinerContext, BatchSinkContext, BatchSourceContext

@Beta
public interface BatchContext
extends DatasetContext, TransformContext

Context passed to Batch Source and Sink.

Method Summary

Modifier and Type	Method and Description
void	createDataset(String datasetName, String typeName, DatasetProperties properties) Create a new dataset instance.
boolean	datasetExists(String datasetName) Check whether a dataset exists in the current namespace.
SettableArguments	getArguments() Returns settable pipeline arguments.

Methods inherited from interface io.cdap.cdap.api.data.DatasetContext

discardDataset, getDataset, getDataset, getDataset, getDataset, releaseDataset

Methods inherited from interface io.cdap.cdap.etl.api.StageContext

getFailureCollector, getInputSchema, getInputSchemas, getInputStages, getLogicalStartTime, getMetrics, getNamespace, getOutputPortSchemas, getOutputSchema, getPipelineName, getPluginProperties, getPluginProperties, getStageName, loadPluginClass, newPluginInstance

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

getServiceURL, getServiceURL, getServiceURL, openConnection

Methods inherited from interface io.cdap.cdap.api.metadata.MetadataReader

getMetadata, getMetadata

Methods inherited from interface io.cdap.cdap.api.metadata.MetadataWriter

addProperties, addTags, addTags, removeMetadata, removeProperties, removeProperties, removeTags, removeTags

Methods inherited from interface io.cdap.cdap.etl.api.lineage.field.LineageRecorder

record

Methods inherited from interface io.cdap.cdap.etl.api.LookupProvider

provide

Method Detail

createDataset

void createDataset(String datasetName,
                   String typeName,
                   DatasetProperties properties)
            throws DatasetManagementException

Create a new dataset instance.

Parameters:

datasetName - the name of the new dataset

typeName - the type of the dataset to create

properties - the properties for the new dataset

Throws:

InstanceConflictException - if the dataset already exists

DatasetManagementException - for any issues encountered in the dataset system, or if the dataset type's create method fails.

datasetExists

boolean datasetExists(String datasetName)
               throws DatasetManagementException

Check whether a dataset exists in the current namespace.

Parameters:

datasetName - the name of the dataset

Returns:

whether a dataset of that name exists

Throws:

DatasetManagementException - for any issues encountered in the dataset system

getArguments

SettableArguments getArguments()

Returns settable pipeline arguments. These arguments are shared by all pipeline stages, so plugins should be careful to prefix any arguments that should not be clobbered by other pipeline stages.

Specified by:

getArguments in interface StageContext

Returns:

settable pipeline arguments