org.apache.samza.system

Class SystemStreamMetadata

java.lang.Object

org.apache.samza.system.SystemStreamMetadata

public class SystemStreamMetadata
extends java.lang.Object

SystemAdmins use this class to return useful metadata about a stream's offset and partition information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SystemStreamMetadata.OffsetType OffsetType is an enum used to define which offset should be used when reading from a SystemStreamPartition for the first time.
static class	SystemStreamMetadata.SystemStreamPartitionMetadata Provides offset information for a given SystemStreamPartition.

Constructor Summary

Constructors

Constructor and Description
SystemStreamMetadata(java.lang.String streamName, java.util.Map<Partition,SystemStreamMetadata.SystemStreamPartitionMetadata> partitionMetadata)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getStreamName()
java.util.Map<Partition,SystemStreamMetadata.SystemStreamPartitionMetadata>	getSystemStreamPartitionMetadata()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemStreamMetadata

public SystemStreamMetadata(java.lang.String streamName,
                            java.util.Map<Partition,SystemStreamMetadata.SystemStreamPartitionMetadata> partitionMetadata)

Method Detail

getStreamName

public java.lang.String getStreamName()

Returns:

The stream name that's associated with the metadata contained in an instance of this class.

getSystemStreamPartitionMetadata

public java.util.Map<Partition,SystemStreamMetadata.SystemStreamPartitionMetadata> getSystemStreamPartitionMetadata()

Returns:

A map of SystemStreamPartitionMetadata that includes offset information for each partition.

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