org.apache.beam.sdk.io.cdap.context

Class BatchContextImpl

java.lang.Object

org.apache.beam.sdk.io.cdap.context.BatchContextImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

BatchSinkContextImpl, BatchSourceContextImpl, StreamingSourceContextImpl

public abstract class BatchContextImpl
extends java.lang.Object
implements BatchContext

Class for Batch, Sink and Stream CDAP wrapper classes that use it to provide common details.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SCHEMA_FIELD_NAME
static java.lang.String	DEFAULT_SCHEMA_RECORD_NAME
protected InputFormatProvider	inputFormatProvider This should be set after SubmitterLifecycle.prepareRun(Object) call with passing this context object as a param.
protected OutputFormatProvider	outputFormatProvider This should be set after SubmitterLifecycle.prepareRun(Object) call with passing this context object as a param.
protected java.util.Map<java.lang.String,java.lang.String>	settableArguments This should be set after SubmitterLifecycle.prepareRun(Object) call with passing this context object as a param.

Constructor Summary

Constructors

Constructor and Description
BatchContextImpl()

Method Summary

Modifier and Type	Method and Description
void	addProperties(MetadataEntity metadataEntity, java.util.Map<java.lang.String,java.lang.String> properties)
void	addTags(MetadataEntity metadataEntity, java.lang.Iterable<java.lang.String> tags)
void	addTags(MetadataEntity metadataEntity, java.lang.String... tags)
void	createDataset(java.lang.String datasetName, java.lang.String typeName, DatasetProperties properties)
boolean	datasetExists(java.lang.String datasetName)
void	discardDataset(Dataset dataset)
SettableArguments	getArguments()
<T extends Dataset> T	getDataset(java.lang.String name)
<T extends Dataset> T	getDataset(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> arguments)
<T extends Dataset> T	getDataset(java.lang.String namespace, java.lang.String name)
<T extends Dataset> T	getDataset(java.lang.String namespace, java.lang.String name, java.util.Map<java.lang.String,java.lang.String> arguments)
FailureCollector	getFailureCollector()
InputFormatProvider	getInputFormatProvider()
io.cdap.cdap.api.data.schema.Schema	getInputSchema()
java.util.Map<java.lang.String,io.cdap.cdap.api.data.schema.Schema>	getInputSchemas()
long	getLogicalStartTime()
java.util.Map<MetadataScope,Metadata>	getMetadata(MetadataEntity metadataEntity)
Metadata	getMetadata(MetadataScope scope, MetadataEntity metadataEntity)
StageMetrics	getMetrics()
java.lang.String	getNamespace()
OutputFormatProvider	getOutputFormatProvider()
java.util.Map<java.lang.String,io.cdap.cdap.api.data.schema.Schema>	getOutputPortSchemas()
io.cdap.cdap.api.data.schema.Schema	getOutputSchema()
java.lang.String	getPipelineName()
PluginProperties	getPluginProperties()
PluginProperties	getPluginProperties(java.lang.String pluginId)
java.net.URL	getServiceURL(java.lang.String serviceId)
java.net.URL	getServiceURL(java.lang.String applicationId, java.lang.String serviceId)
java.lang.String	getStageName()
<T> java.lang.Class<T>	loadPluginClass(java.lang.String pluginId)
<T> T	newPluginInstance(java.lang.String pluginId)
<T> Lookup<T>	provide(java.lang.String table, java.util.Map<java.lang.String,java.lang.String> arguments)
void	record(java.util.List<FieldOperation> fieldOperations)
void	releaseDataset(Dataset dataset)
void	removeMetadata(MetadataEntity metadataEntity)
void	removeProperties(MetadataEntity metadataEntity)
void	removeProperties(MetadataEntity metadataEntity, java.lang.String... keys)
void	removeTags(MetadataEntity metadataEntity)
void	removeTags(MetadataEntity metadataEntity, java.lang.String... tags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getInputStages

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

getServiceURL, openConnection

Field Detail

DEFAULT_SCHEMA_FIELD_NAME

public static final java.lang.String DEFAULT_SCHEMA_FIELD_NAME

See Also:

Constant Field Values

DEFAULT_SCHEMA_RECORD_NAME

public static final java.lang.String DEFAULT_SCHEMA_RECORD_NAME

See Also:

Constant Field Values

inputFormatProvider

protected InputFormatProvider inputFormatProvider

This should be set after SubmitterLifecycle.prepareRun(Object) call with passing this context object as a param.

outputFormatProvider

protected OutputFormatProvider outputFormatProvider

This should be set after SubmitterLifecycle.prepareRun(Object) call with passing this context object as a param.

settableArguments

protected java.util.Map<java.lang.String,java.lang.String> settableArguments

This should be set after SubmitterLifecycle.prepareRun(Object) call with passing this context object as a param.

Constructor Detail

BatchContextImpl

public BatchContextImpl()

Method Detail

getInputFormatProvider

public InputFormatProvider getInputFormatProvider()

getOutputFormatProvider

public OutputFormatProvider getOutputFormatProvider()

getStageName

public java.lang.String getStageName()

Specified by:

getStageName in interface StageContext

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface StageContext

getPipelineName

public java.lang.String getPipelineName()

Specified by:

getPipelineName in interface StageContext

getLogicalStartTime

public long getLogicalStartTime()

Specified by:

getLogicalStartTime in interface StageContext

getMetrics

public StageMetrics getMetrics()

Specified by:

getMetrics in interface StageContext

getPluginProperties

public PluginProperties getPluginProperties()

Specified by:

getPluginProperties in interface StageContext

getPluginProperties

public PluginProperties getPluginProperties(java.lang.String pluginId)

Specified by:

getPluginProperties in interface StageContext

loadPluginClass

public <T> java.lang.Class<T> loadPluginClass(java.lang.String pluginId)

Specified by:

loadPluginClass in interface StageContext

newPluginInstance

public <T> T newPluginInstance(java.lang.String pluginId)
                        throws java.lang.InstantiationException

Specified by:

newPluginInstance in interface StageContext

Throws:

java.lang.InstantiationException

getInputSchema

public io.cdap.cdap.api.data.schema.Schema getInputSchema()

Specified by:

getInputSchema in interface StageContext

getInputSchemas

@Nullable
public java.util.Map<java.lang.String,io.cdap.cdap.api.data.schema.Schema> getInputSchemas()

Specified by:

getInputSchemas in interface StageContext

getOutputSchema

public io.cdap.cdap.api.data.schema.Schema getOutputSchema()

Specified by:

getOutputSchema in interface StageContext

getOutputPortSchemas

public java.util.Map<java.lang.String,io.cdap.cdap.api.data.schema.Schema> getOutputPortSchemas()

Specified by:

getOutputPortSchemas in interface StageContext

createDataset

public void createDataset(java.lang.String datasetName,
                          java.lang.String typeName,
                          DatasetProperties properties)
                   throws DatasetManagementException

Specified by:

createDataset in interface BatchContext

Throws:

DatasetManagementException

datasetExists

public boolean datasetExists(java.lang.String datasetName)
                      throws DatasetManagementException

Specified by:

datasetExists in interface BatchContext

Throws:

DatasetManagementException

getArguments

public SettableArguments getArguments()

Specified by:

getArguments in interface BatchContext

Specified by:

getArguments in interface StageContext

getFailureCollector

public FailureCollector getFailureCollector()

Specified by:

getFailureCollector in interface StageContext

getServiceURL

@Nullable
public java.net.URL getServiceURL(java.lang.String applicationId,
                                            java.lang.String serviceId)

Specified by:

getServiceURL in interface ServiceDiscoverer

getServiceURL

@Nullable
public java.net.URL getServiceURL(java.lang.String serviceId)

Specified by:

getServiceURL in interface ServiceDiscoverer

getMetadata

public java.util.Map<MetadataScope,Metadata> getMetadata(MetadataEntity metadataEntity)
                                                  throws MetadataException

Specified by:

getMetadata in interface MetadataReader

Throws:

MetadataException

getMetadata

public Metadata getMetadata(MetadataScope scope,
                            MetadataEntity metadataEntity)
                     throws MetadataException

Specified by:

getMetadata in interface MetadataReader

Throws:

MetadataException

addProperties

public void addProperties(MetadataEntity metadataEntity,
                          java.util.Map<java.lang.String,java.lang.String> properties)

Specified by:

addProperties in interface MetadataWriter

addTags

public void addTags(MetadataEntity metadataEntity,
                    java.lang.String... tags)

Specified by:

addTags in interface MetadataWriter

addTags

public void addTags(MetadataEntity metadataEntity,
                    java.lang.Iterable<java.lang.String> tags)

Specified by:

addTags in interface MetadataWriter

removeMetadata

public void removeMetadata(MetadataEntity metadataEntity)

Specified by:

removeMetadata in interface MetadataWriter

removeProperties

public void removeProperties(MetadataEntity metadataEntity)

Specified by:

removeProperties in interface MetadataWriter

removeProperties

public void removeProperties(MetadataEntity metadataEntity,
                             java.lang.String... keys)

Specified by:

removeProperties in interface MetadataWriter

removeTags

public void removeTags(MetadataEntity metadataEntity)

Specified by:

removeTags in interface MetadataWriter

removeTags

public void removeTags(MetadataEntity metadataEntity,
                       java.lang.String... tags)

Specified by:

removeTags in interface MetadataWriter

record

public void record(java.util.List<FieldOperation> fieldOperations)

Specified by:

record in interface LineageRecorder

getDataset

public <T extends Dataset> T getDataset(java.lang.String name)
                                 throws DatasetInstantiationException

Specified by:

getDataset in interface DatasetContext

Throws:

DatasetInstantiationException

getDataset

public <T extends Dataset> T getDataset(java.lang.String namespace,
                                        java.lang.String name)
                                 throws DatasetInstantiationException

Specified by:

getDataset in interface DatasetContext

Throws:

DatasetInstantiationException

getDataset

public <T extends Dataset> T getDataset(java.lang.String name,
                                        java.util.Map<java.lang.String,java.lang.String> arguments)
                                 throws DatasetInstantiationException

Specified by:

getDataset in interface DatasetContext

Throws:

DatasetInstantiationException

getDataset

public <T extends Dataset> T getDataset(java.lang.String namespace,
                                        java.lang.String name,
                                        java.util.Map<java.lang.String,java.lang.String> arguments)
                                 throws DatasetInstantiationException

Specified by:

getDataset in interface DatasetContext

Throws:

DatasetInstantiationException

releaseDataset

public void releaseDataset(Dataset dataset)

Specified by:

releaseDataset in interface DatasetContext

discardDataset

public void discardDataset(Dataset dataset)

Specified by:

discardDataset in interface DatasetContext

provide

public <T> Lookup<T> provide(java.lang.String table,
                             java.util.Map<java.lang.String,java.lang.String> arguments)

Specified by:

provide in interface LookupProvider