co.cask.cdap.etl.api.batch

Interface BatchContext

All Superinterfaces:

DatasetContext, LookupProvider, 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

Methods

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.
<T> T	getHadoopJob() Deprecated. this method will be removed.
long	getLogicalStartTime() Returns the logical start time of the Batch Job.
Map<String,String>	getRuntimeArguments() Returns runtime arguments of the Batch Job.
void	setRuntimeArgument(String key, String value, boolean overwrite) Updates an entry in the runtime arguments.

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

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

getLogicalStartTime

long getLogicalStartTime()

Returns the logical start time of the Batch Job. Logical start time is the time when this Batch job is supposed to start if this job is started by the scheduler. Otherwise it would be the current time when the job runs.

Returns:

Time in milliseconds since epoch time (00:00:00 January 1, 1970 UTC).

getRuntimeArguments

Map<String,String> getRuntimeArguments()

Returns runtime arguments of the Batch Job.

Returns:

runtime arguments of the Batch Job.

setRuntimeArgument

void setRuntimeArgument(String key,
                      String value,
                      boolean overwrite)

Updates an entry in the runtime arguments.

Parameters:

key - key to update

value - value to update to

overwrite - if true and if the key exists in the runtime arguments, it will get overwritten to the given value; if false, the existing value of the key won't get updated.

getHadoopJob

@Deprecated
<T> T getHadoopJob()

Deprecated. this method will be removed.

Returns the hadoop job.