org.apache.samza.system.descriptors

Class GenericInputDescriptor<StreamMessageType>

java.lang.Object

org.apache.samza.system.descriptors.StreamDescriptor<StreamMessageType,SubClass>

org.apache.samza.system.descriptors.InputDescriptor<StreamMessageType,GenericInputDescriptor<StreamMessageType>>

org.apache.samza.system.descriptors.GenericInputDescriptor<StreamMessageType>

Type Parameters:

StreamMessageType - type of messages in this stream.

public final class GenericInputDescriptor<StreamMessageType>
extends InputDescriptor<StreamMessageType,GenericInputDescriptor<StreamMessageType>>

A GenericInputDescriptor can be used for specifying Samza and system-specific properties of input streams.

If the system provides its own system and stream descriptor implementations, use them instead. Otherwise, use this GenericInputDescriptor to specify Samza-specific properties of the stream, and StreamDescriptor.withStreamConfigs(java.util.Map<java.lang.String, java.lang.String>) to specify additional system specific properties.

Use GenericSystemDescriptor.getInputDescriptor(java.lang.String, org.apache.samza.serializers.Serde<StreamMessageType>) to obtain an instance of this descriptor.

Stream properties provided in configuration override corresponding properties specified using a descriptor.

Method Summary

Modifier and Type	Method and Description
GenericInputDescriptor<StreamMessageType>	withPhysicalName(java.lang.String physicalName) The physical name of the stream on the system on which this stream will be accessed.

Methods inherited from class org.apache.samza.system.descriptors.InputDescriptor

getTransformer, isBounded, shouldBootstrap, shouldDeleteCommittedMessages, shouldResetOffset, toConfig, withOffsetDefault, withPriority

Methods inherited from class org.apache.samza.system.descriptors.StreamDescriptor

getPhysicalName, getSerde, getStreamId, getSystemDescriptor, getSystemName, withStreamConfigs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withPhysicalName

public GenericInputDescriptor<StreamMessageType> withPhysicalName(java.lang.String physicalName)

Description copied from class: StreamDescriptor

The physical name of the stream on the system on which this stream will be accessed. This is opposed to the streamId which is the logical name that Samza uses to identify the stream.

A physical name could be a Kafka topic name, an HDFS file URN, or any other system-specific identifier.

If not provided, the logical streamId is used as the physical name.

Overrides:

withPhysicalName in class StreamDescriptor<StreamMessageType,GenericInputDescriptor<StreamMessageType>>

Parameters:

physicalName - physical name for this stream.

Returns:

this stream descriptor.