StreamApplicationDescriptor (samza-api 1.9.0-SNAPSHOT API)
JavaScript is disabled on your browser.
Skip navigation links
Overview
Package
Class
Tree
Deprecated
Index
Help
Prev Class
Next Class
Frames
No Frames
All Classes
Summary: 
Nested | 
Field | 
Constr | 
Method
Detail: 
Field | 
Constr | 
Method
org.apache.samza.application.descriptors
Interface StreamApplicationDescriptor
All Superinterfaces:
ApplicationDescriptor<StreamApplicationDescriptor>
@InterfaceStability.Evolving
public interface StreamApplicationDescriptor
extends ApplicationDescriptor<StreamApplicationDescriptor>
A StreamApplicationDescriptor contains the description of inputs, outputs, state, configuration and the
processing logic for a Samza High Level API StreamApplication.
Use the StreamApplicationDescriptor obtained from SamzaApplication.describe(S) to get the
MessageStreams, OutputStreams and Tables corresponding to their respective
InputDescriptors, OutputDescriptors and TableDescriptors.
Use the MessageStream API operators to describe the processing logic for the StreamApplication.
Method Summary
All Methods Instance Methods Abstract Methods 
Modifier and Type
Method and Description
<M> MessageStream<M>
getInputStream(InputDescriptor<M,?> inputDescriptor)
Gets the input MessageStream corresponding to the inputDescriptor.
<M> OutputStream<M>
getOutputStream(OutputDescriptor<M,?> outputDescriptor)
Gets the OutputStream corresponding to the outputDescriptor.
<K,V> Table<KV<K,V>>
getTable(TableDescriptor<K,V,?> tableDescriptor)
Gets the Table corresponding to the TableDescriptor.
Methods inherited from interface org.apache.samza.application.descriptors.ApplicationDescriptor
getConfig, withApplicationContainerContextFactory, withApplicationTaskContextFactory, withDefaultSystem, withMetricsReporterFactories, withProcessorLifecycleListenerFactory
Method Detail
getInputStream
<M> MessageStream<M> getInputStream(InputDescriptor<M,?> inputDescriptor)
Gets the input MessageStream corresponding to the inputDescriptor.
A MessageStream<KV<K, V>, obtained by calling this method with a descriptor with a KVSerde<K, V>,
can receive messages of type KV<K, V>. An input MessageStream<M>, obtained using a descriptor with
any other Serde<M>, can receive messages of type M - the key in the incoming message is ignored.
A KVSerde<NoOpSerde, NoOpSerde> or NoOpSerde may be used for the descriptor if the
SystemConsumer deserializes the incoming messages itself, and no further deserialization is required from
the framework.
Multiple invocations of this method with the same inputDescriptor will throw an
IllegalStateException.
Type Parameters:
M - the type of messages in the input MessageStream
Parameters:
inputDescriptor - the descriptor for the stream
Returns:
the input MessageStream
Throws:
java.lang.IllegalStateException - when invoked multiple times with the same inputDescriptor
getOutputStream
<M> OutputStream<M> getOutputStream(OutputDescriptor<M,?> outputDescriptor)
Gets the OutputStream corresponding to the outputDescriptor.
An OutputStream<KV<K, V>>, obtained by calling this method with a descriptor with a KVSerde<K, V>,
can send messages of type KV<K, V>. An OutputStream<M>, obtained using a descriptor with any
other Serde<M>, can send messages of type M without a key.
A KVSerde<NoOpSerde, NoOpSerde> or NoOpSerde may be used for the descriptor if the
SystemProducer serializes the outgoing messages itself, and no prior serialization is required from
the framework.
When sending messages to an OutputStream<KV<K, V>>, messages are partitioned using their serialized key.
When sending messages to any other OutputStream<M>, messages are partitioned using a null partition key.
Multiple invocations of this method with the same outputDescriptor will throw an
IllegalStateException.
Type Parameters:
M - the type of messages in the OutputStream
Parameters:
outputDescriptor - the descriptor for the stream
Returns:
the OutputStream
Throws:
java.lang.IllegalStateException - when invoked multiple times with the same outputDescriptor
getTable
<K,V> Table<KV<K,V>> getTable(TableDescriptor<K,V,?> tableDescriptor)
Gets the Table corresponding to the TableDescriptor.
Multiple invocations of this method with the same TableDescriptor will throw an
IllegalStateException.
Type Parameters:
K - the type of the key
V - the type of the value
Parameters:
tableDescriptor - the TableDescriptor
Returns:
the Table corresponding to the tableDescriptor
Throws:
java.lang.IllegalStateException - when invoked multiple times with the same TableDescriptor
Skip navigation links
Overview
Package
Class
Tree
Deprecated
Index
Help
Prev Class
Next Class
Frames
No Frames
All Classes
Summary: 
Nested | 
Field | 
Constr | 
Method
Detail: 
Field | 
Constr | 
Method