org.apache.samza.operators.data

Class IncomingSystemMessageEnvelope

java.lang.Object

org.apache.samza.operators.data.IncomingSystemMessageEnvelope

All Implemented Interfaces:

MessageEnvelope<java.lang.Object,java.lang.Object>

public class IncomingSystemMessageEnvelope
extends java.lang.Object
implements MessageEnvelope<java.lang.Object,java.lang.Object>

A MessageEnvelope that provides additional information about its input SystemStreamPartition and its Offset within the SystemStreamPartition.

Note: the Offset is only unique and comparable within its SystemStreamPartition.

Constructor Summary

Constructors

Constructor and Description
IncomingSystemMessageEnvelope(IncomingMessageEnvelope ime) Creates an IncomingSystemMessageEnvelope from the IncomingMessageEnvelope.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getKey() Get the key for this MessageEnvelope.
java.lang.Object	getMessage() Get the message in this MessageEnvelope.
Offset	getOffset()
SystemStreamPartition	getSystemStreamPartition()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.samza.operators.data.MessageEnvelope

isDelete

Constructor Detail

IncomingSystemMessageEnvelope

public IncomingSystemMessageEnvelope(IncomingMessageEnvelope ime)

Creates an IncomingSystemMessageEnvelope from the IncomingMessageEnvelope.

Parameters:

ime - the IncomingMessageEnvelope from the input system.

Method Detail

getKey

public java.lang.Object getKey()

Description copied from interface: MessageEnvelope

Get the key for this MessageEnvelope.

Specified by:

getKey in interface MessageEnvelope<java.lang.Object,java.lang.Object>

Returns:

the key for this MessageEnvelope

getMessage

public java.lang.Object getMessage()

Description copied from interface: MessageEnvelope

Get the message in this MessageEnvelope.

Specified by:

getMessage in interface MessageEnvelope<java.lang.Object,java.lang.Object>

Returns:

the message in this MessageEnvelope

getOffset

public Offset getOffset()

getSystemStreamPartition

public SystemStreamPartition getSystemStreamPartition()