io.cdap.cdap.etl.api.batch

Interface BatchSourceContext

All Superinterfaces:

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

@Beta
public interface BatchSourceContext
extends BatchContext

Context of a Batch Source.

Method Summary

Modifier and Type	Method and Description
int	getMaxPreviewRecords()
boolean	isPreviewEnabled() Indicates whether the pipeline is running in preview.
void	setInput(Input input) Overrides the input configuration of this Batch job to the specified Input.

Methods inherited from interface io.cdap.cdap.etl.api.batch.BatchContext

createDataset, datasetExists, getArguments

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.api.feature.FeatureFlagsProvider

isFeatureEnabled

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

provide

Method Detail

setInput

void setInput(Input input)

Overrides the input configuration of this Batch job to the specified Input.

Parameters:

input - the input to be used

isPreviewEnabled

boolean isPreviewEnabled()

Indicates whether the pipeline is running in preview.

Returns:

a boolean value which indicates the pipeline is running in preview mode.

getMaxPreviewRecords

int getMaxPreviewRecords()

Returns:

maximum number of records to read in preview mode.