org.apache.samza.system

Class OutgoingMessageEnvelope

java.lang.Object

org.apache.samza.system.OutgoingMessageEnvelope

public class OutgoingMessageEnvelope
extends java.lang.Object

An OutgoingMessageEnvelope is sent to a specified SystemStream via the appropriate SystemProducer from the user's StreamTask. StreamTasks consume from their input streams via their process method and write to their output streams by sending OutgoingMessageEnvelopes via the provided MessageCollector

Constructor Summary

Constructors

Constructor and Description
OutgoingMessageEnvelope(SystemStream systemStream, java.lang.Object message) Constructs a new OutgoingMessageEnvelope from specified components.
OutgoingMessageEnvelope(SystemStream systemStream, java.lang.Object key, java.lang.Object message) Constructs a new OutgoingMessageEnvelope from specified components.
OutgoingMessageEnvelope(SystemStream systemStream, java.lang.Object partitionKey, java.lang.Object key, java.lang.Object message) Constructs a new OutgoingMessageEnvelope from specified components.
OutgoingMessageEnvelope(SystemStream systemStream, java.lang.String keySerializerName, java.lang.String messageSerializerName, java.lang.Object partitionKey, java.lang.Object key, java.lang.Object message) Constructs a new OutgoingMessageEnvelope from specified components.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Object	getKey()
java.lang.String	getKeySerializerName()
java.lang.Object	getMessage()
java.lang.String	getMessageSerializerName()
java.lang.Object	getPartitionKey()
SystemStream	getSystemStream()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OutgoingMessageEnvelope

public OutgoingMessageEnvelope(SystemStream systemStream,
                               java.lang.String keySerializerName,
                               java.lang.String messageSerializerName,
                               java.lang.Object partitionKey,
                               java.lang.Object key,
                               java.lang.Object message)

Constructs a new OutgoingMessageEnvelope from specified components.

Parameters:

systemStream - Object representing the appropriate stream of which this envelope will be sent on.

keySerializerName - String representing the serializer used for serializing this envelope's key.

messageSerializerName - String representing the serializer used for serializing this envelope's message.

partitionKey - A key representing which partition of the systemStream to send this envelope on.

key - A deserialized key to be used for the message.

message - A deserialized message to be sent in this envelope.

OutgoingMessageEnvelope

public OutgoingMessageEnvelope(SystemStream systemStream,
                               java.lang.Object partitionKey,
                               java.lang.Object key,
                               java.lang.Object message)

Constructs a new OutgoingMessageEnvelope from specified components.

Parameters:

systemStream - Object representing the appropriate stream of which this envelope will be sent on.

partitionKey - A key representing which partition of the systemStream to send this envelope on.

key - A deserialized key to be used for the message.

message - A deserialized message to be sent in this envelope.

OutgoingMessageEnvelope

public OutgoingMessageEnvelope(SystemStream systemStream,
                               java.lang.Object key,
                               java.lang.Object message)

Constructs a new OutgoingMessageEnvelope from specified components.

Parameters:

systemStream - Object representing the appropriate stream of which this envelope will be sent on.

key - A deserialized key to be used for the message.

message - A deserialized message to be sent in this envelope.

OutgoingMessageEnvelope

public OutgoingMessageEnvelope(SystemStream systemStream,
                               java.lang.Object message)

Constructs a new OutgoingMessageEnvelope from specified components.

Parameters:

systemStream - Object representing the appropriate stream of which this envelope will be sent on.

message - A deserialized message to be sent in this envelope.

Method Detail

getSystemStream

public SystemStream getSystemStream()

getKeySerializerName

public java.lang.String getKeySerializerName()

getMessageSerializerName

public java.lang.String getMessageSerializerName()

getPartitionKey

public java.lang.Object getPartitionKey()

getKey

public java.lang.Object getKey()

getMessage

public java.lang.Object getMessage()

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