io.cdap.delta.api

Interface DeltaRuntimeContext

All Superinterfaces:

io.cdap.cdap.api.plugin.PluginContext

All Known Subinterfaces:

DeltaSourceContext, DeltaTargetContext

public interface DeltaRuntimeContext
extends io.cdap.cdap.api.plugin.PluginContext

Runtime context for a CDC component.

Method Summary

Modifier and Type	Method and Description
String	getApplicationName()
int	getInstanceId()
int	getMaxRetrySeconds()
io.cdap.cdap.api.metrics.Metrics	getMetrics()
String	getRunId()
Map<String,String>	getRuntimeArguments()
byte[]	getState(String key) Get state associated with the given key.
void	putState(String key, byte[] val) Write state for a given key.

Methods inherited from interface io.cdap.cdap.api.plugin.PluginContext

getPluginProperties, getPluginProperties, loadPluginClass, newPluginInstance, newPluginInstance

Method Detail

getApplicationName

String getApplicationName()

Returns:

the application name

getRunId

String getRunId()

Returns:

the program run id

getMetrics

io.cdap.cdap.api.metrics.Metrics getMetrics()

Returns:

metrics emitter

getRuntimeArguments

Map<String,String> getRuntimeArguments()

Returns:

A map of runtime argument key and value

getInstanceId

int getInstanceId()

Returns:

id of the worker instance.

getMaxRetrySeconds

int getMaxRetrySeconds()

Returns:

maximum amount of seconds to retry failures before failing the pipeline

getState

@Nullable
byte[] getState(String key)
                   throws IOException

Get state associated with the given key.

Parameters:

key - key to fetch state with

Returns:

state associated with the given key

Throws:

IOException

putState

void putState(String key,
              byte[] val)
       throws IOException

Write state for a given key. Any existing state will be overwritten.

Parameters:

key - key to write to

val - state to write

Throws:

IOException