com.opendxl.databus.consumer

Class OffsetAndMetadata

java.lang.Object

com.opendxl.databus.consumer.OffsetAndMetadata

All Implemented Interfaces:

java.io.Serializable

public final class OffsetAndMetadata
extends java.lang.Object
implements java.io.Serializable

The Kafka offset commit API allows users to provide additional metadata (in the form of a string) when an offset is committed. This can be useful (for example) to store information about which node made the commit, what time the commit was made, etc.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OffsetAndMetadata(long offset) Construct a new OffsetAndMetadata object for committing through Consumer.
OffsetAndMetadata(long offset, java.lang.String metadata) Construct a new OffsetAndMetadata object for committing through Consumer.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Overriding equals method
int	hashCode() Get the hashcode of the OffsetAndMetadata object
java.lang.String	metadata() Returns the metadata value as String
long	offset() Returns the offset value number
java.lang.String	toString() Get the toString method of the OffsetAndMetadata object

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OffsetAndMetadata

public OffsetAndMetadata(long offset,
                         java.lang.String metadata)

Construct a new OffsetAndMetadata object for committing through Consumer.

Parameters:

offset - The offset to be committed

metadata - Non-null metadata

OffsetAndMetadata

public OffsetAndMetadata(long offset)

Construct a new OffsetAndMetadata object for committing through Consumer. The metadata associated with the commit will be empty.

Parameters:

offset - The offset to be committed

Method Detail

offset

public long offset()

Returns the offset value number

Returns:

The Offset value number

metadata

public java.lang.String metadata()

Returns the metadata value as String

Returns:

Metadata of the consumer

equals

public boolean equals(java.lang.Object o)

Overriding equals method

Overrides:

equals in class java.lang.Object

Returns:

True if OffsetAndMetadata is equals

hashCode

public int hashCode()

Get the hashcode of the OffsetAndMetadata object

Overrides:

hashCode in class java.lang.Object

Returns:

The hashcode of the OffsetAndMetadata object as int

toString

public java.lang.String toString()

Get the toString method of the OffsetAndMetadata object

Overrides:

toString in class java.lang.Object

Returns:

The toString of the OffsetAndMetadata object