org.apache.samza.system

Class SystemStreamMetadata.SystemStreamPartitionMetadata

java.lang.Object

org.apache.samza.system.SystemStreamMetadata.SystemStreamPartitionMetadata

Enclosing class:

SystemStreamMetadata

public static class SystemStreamMetadata.SystemStreamPartitionMetadata
extends java.lang.Object

Provides offset information for a given SystemStreamPartition. This currently only includes offset information.

Constructor Summary

Constructors

Constructor and Description
SystemStreamPartitionMetadata(java.lang.String oldestOffset, java.lang.String newestOffset, java.lang.String upcomingOffset)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getNewestOffset()
java.lang.String	getOffset(SystemStreamMetadata.OffsetType offsetType)
java.lang.String	getOldestOffset()
java.lang.String	getUpcomingOffset()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemStreamPartitionMetadata

public SystemStreamPartitionMetadata(java.lang.String oldestOffset,
                                     java.lang.String newestOffset,
                                     java.lang.String upcomingOffset)

Method Detail

getOldestOffset

public java.lang.String getOldestOffset()

Returns:

The oldest offset that still exists in the stream for the partition given. If a partition has two messages with offsets 0 and 1, respectively, then this method would return 0 for the oldest offset. This offset is useful when one wishes to read all messages in a stream from the very beginning. A null value means the stream is empty.

getNewestOffset

public java.lang.String getNewestOffset()

Returns:

The newest offset that exists in the stream for the partition given. If a partition has two messages with offsets 0 and 1, respectively, then this method would return 1 for the newest offset. This offset is useful when one wishes to see if all messages have been read from a stream (offset of last message read == newest offset). A null value means the stream is empty.

getUpcomingOffset

public java.lang.String getUpcomingOffset()

Returns:

The offset that represents the next message to be written in the stream for the partition given. If a partition has two messages with offsets 0 and 1, respectively, then this method would return 2 for the upcoming offset. This offset is useful when one wishes to pick up reading at the very end of a stream. A null value means the stream is empty.

getOffset

public java.lang.String getOffset(SystemStreamMetadata.OffsetType offsetType)

Parameters:

offsetType - The type of offset to get. Either oldest, newest, or upcoming.

Returns:

The corresponding offset for the offset type requested.

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