org.apache.samza.system

Class IncomingMessageEnvelope

java.lang.Object

org.apache.samza.system.IncomingMessageEnvelope

public class IncomingMessageEnvelope
extends java.lang.Object

This class represents a message envelope that is received by a StreamTask for each message that is received from a partition of a specific input stream.

Constructor Summary

Constructors

Constructor and Description
IncomingMessageEnvelope(SystemStreamPartition systemStreamPartition, java.lang.String offset, java.lang.Object key, java.lang.Object message) Constructs a new IncomingMessageEnvelope from specified components.
IncomingMessageEnvelope(SystemStreamPartition systemStreamPartition, java.lang.String offset, java.lang.Object key, java.lang.Object message, int size) Constructs a new IncomingMessageEnvelope from specified components.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Object	getKey()
java.lang.Object	getMessage()
java.lang.String	getOffset()
int	getSize()
SystemStreamPartition	getSystemStreamPartition()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IncomingMessageEnvelope

public IncomingMessageEnvelope(SystemStreamPartition systemStreamPartition,
                       java.lang.String offset,
                       java.lang.Object key,
                       java.lang.Object message)

Constructs a new IncomingMessageEnvelope from specified components.

Parameters:

systemStreamPartition - The aggregate object representing the incoming stream name, the name of the cluster from which the stream came, and the partition of the stream from which the message was received.

offset - The offset in the partition that the message was received from.

key - A deserialized key received from the partition offset.

message - A deserialized message received from the partition offset.

IncomingMessageEnvelope

public IncomingMessageEnvelope(SystemStreamPartition systemStreamPartition,
                       java.lang.String offset,
                       java.lang.Object key,
                       java.lang.Object message,
                       int size)

Constructs a new IncomingMessageEnvelope from specified components.

Parameters:

systemStreamPartition - The aggregate object representing the incoming stream name, the name of the cluster from which the stream came, and the partition of the stream from which the message was received.

offset - The offset in the partition that the message was received from.

key - A deserialized key received from the partition offset.

message - A deserialized message received from the partition offset.

size - size of the message and key in bytes.

Method Detail

getSystemStreamPartition

public SystemStreamPartition getSystemStreamPartition()

getOffset

public java.lang.String getOffset()

getKey

public java.lang.Object getKey()

getMessage

public java.lang.Object getMessage()

getSize

public int getSize()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object