io.cdap.cdap.etl.api.action

Interface ActionContext

All Superinterfaces:

LineageRecorder, MetadataReader, MetadataWriter, SecureStore, SecureStoreManager, ServiceDiscoverer, StageContext, Transactional

public interface ActionContext
extends StageContext, Transactional, SecureStore, SecureStoreManager, LineageRecorder

Represents the context available to the action plugin during runtime.

Method Summary

Modifier and Type	Method and Description
SettableArguments	getArguments() Returns settable pipeline arguments.
default void	record(List<FieldOperation> fieldOperations) Deprecated. use LineageRecorder.record(Collection) to emit field operations for actions, that method requires the input field to contain the previous originated operation name. Using that DAG can be computed so the field linage can be computed.
default void	registerLineage(String referenceName, AccessType accessType) Register lineage for this Spark program using the given reference name

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.api.Transactional

execute, execute

Methods inherited from interface io.cdap.cdap.api.security.store.SecureStore

get, list

Methods inherited from interface io.cdap.cdap.api.security.store.SecureStoreManager

delete, put

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

flushLineage, record

Method Detail

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

record

@Deprecated
default void record(List<FieldOperation> fieldOperations)

Deprecated. use LineageRecorder.record(Collection) to emit field operations for actions, that method requires the input field to contain the previous originated operation name. Using that DAG can be computed so the field linage can be computed.

This method is based on the assumption that the plugin has an input schema or output schema and the DAG of the operations are known. Actions do not have input and output schema, and the DAG is unknown to us. Therefore, this method cannot be used to emit field lineage information.

Parameters:

fieldOperations - the operations to be recorded

registerLineage

default void registerLineage(String referenceName,
                             AccessType accessType)
                      throws DatasetManagementException,
                             org.apache.tephra.TransactionFailureException

Register lineage for this Spark program using the given reference name

Parameters:

referenceName - reference name used for source

accessType - the access type of the lineage

Throws:

DatasetManagementException - thrown if there was an error in creating reference dataset

org.apache.tephra.TransactionFailureException - thrown if there was an error while fetching the dataset to register usage