org.apache.samza.task

Interface TaskContext

public interface TaskContext

A TaskContext provides resources about the StreamTask, particularly during initialization in an InitableTask.

Method Summary

Modifier and Type	Method and Description
MetricsRegistry	getMetricsRegistry()
SamzaContainerContext	getSamzaContainerContext()
java.lang.Object	getStore(java.lang.String name)
java.util.Set<SystemStreamPartition>	getSystemStreamPartitions()
TaskName	getTaskName()
default java.lang.Object	getUserContext() Gets the user-defined context.
void	setStartingOffset(SystemStreamPartition ssp, java.lang.String offset) Set the starting offset for the given SystemStreamPartition.
default void	setUserContext(java.lang.Object context) Sets the user-defined context.

Method Detail

getMetricsRegistry

MetricsRegistry getMetricsRegistry()

getSystemStreamPartitions

java.util.Set<SystemStreamPartition> getSystemStreamPartitions()

getStore

java.lang.Object getStore(java.lang.String name)

getTaskName

TaskName getTaskName()

getSamzaContainerContext

SamzaContainerContext getSamzaContainerContext()

setStartingOffset

void setStartingOffset(SystemStreamPartition ssp,
                       java.lang.String offset)

Set the starting offset for the given SystemStreamPartition. Offsets can only be set for a SystemStreamPartition assigned to this task (as returned by getSystemStreamPartitions()); trying to set the offset for any other partition will have no effect. NOTE: this feature is experimental, and the API may change in a future release.

Parameters:

ssp - SystemStreamPartition whose offset should be set

offset - to set for the given SystemStreamPartition

setUserContext

default void setUserContext(java.lang.Object context)

Sets the user-defined context.

Parameters:

context - the user-defined context to set

getUserContext

default java.lang.Object getUserContext()

Gets the user-defined context.

Returns:

the user-defined context if set, else null