org.apache.samza.application.descriptors

Interface TaskApplicationDescriptor

All Superinterfaces:

ApplicationDescriptor<TaskApplicationDescriptor>

@InterfaceStability.Evolving
public interface TaskApplicationDescriptor
extends ApplicationDescriptor<TaskApplicationDescriptor>

A TaskApplicationDescriptor contains the description of inputs, outputs, state, configuration and the processing logic for a Samza Low Level API TaskApplication.

Use the TaskApplicationDescriptor obtained from SamzaApplication.describe(S) to add the InputDescriptors, OutputDescriptors and TableDescriptors for streams and tables to be used in the task implementation.

Use withTaskFactory(org.apache.samza.task.TaskFactory) to set the factory for the StreamTask or AsyncStreamTask implementation that contains the processing logic for the TaskApplication.

Method Summary

Modifier and Type	Method and Description
TaskApplicationDescriptor	withInputStream(InputDescriptor isd) Adds the input stream to the application.
TaskApplicationDescriptor	withOutputStream(OutputDescriptor osd) Adds the output stream to the application.
TaskApplicationDescriptor	withTable(TableDescriptor table) Adds the TableDescriptor used in the application
TaskApplicationDescriptor	withTaskFactory(TaskFactory factory) Sets the StreamTaskFactory or AsyncStreamTaskFactory for the StreamTask or AsyncStreamTask implementation that contains the processing logic for the TaskApplication.

Methods inherited from interface org.apache.samza.application.descriptors.ApplicationDescriptor

getConfig, withApplicationContainerContextFactory, withApplicationTaskContextFactory, withDefaultSystem, withMetricsReporterFactories, withProcessorLifecycleListenerFactory

Method Detail

withTaskFactory

TaskApplicationDescriptor withTaskFactory(TaskFactory factory)

Sets the StreamTaskFactory or AsyncStreamTaskFactory for the StreamTask or AsyncStreamTask implementation that contains the processing logic for the TaskApplication.

The provided taskFactory instance must be Serializable.

Parameters:

factory - the TaskFactory for the Low Level API Task implementation

Returns:

this TaskApplicationDescriptor

withInputStream

TaskApplicationDescriptor withInputStream(InputDescriptor isd)

Adds the input stream to the application.

Parameters:

isd - the InputDescriptor

Returns:

this TaskApplicationDescriptor

withOutputStream

TaskApplicationDescriptor withOutputStream(OutputDescriptor osd)

Adds the output stream to the application.

Parameters:

osd - the OutputDescriptor of the output stream

Returns:

this TaskApplicationDescriptor

withTable

TaskApplicationDescriptor withTable(TableDescriptor table)

Adds the TableDescriptor used in the application

Parameters:

table - TableDescriptor

Returns:

this TaskApplicationDescriptor