EventPosition Interface

Package:

com.microsoft.azure.eventhubs

public interface EventPosition

Defines a position of an EventData in the event hub partition. The position can be an Offset, Sequence Number, or EnqueuedTime.

Method Summary

Modifier and Type	Method and Description
EventPosition	fromEndOfStream() Returns the position for the end of a stream. Provide this position in receiver creation to start receiving from the next available event in the partition after the receiver is created.
EventPosition	fromEnqueuedTime(Instant dateTime) Creates a position at the given Instant.
EventPosition	fromOffset(String offset) Creates a position at the given offset. The specified event will not be included. Instead, the next event is returned.
EventPosition	fromOffset(String offset, boolean inclusiveFlag) Creates a position at the given offset.
EventPosition	fromSequenceNumber(Long sequenceNumber) Creates a position at the given sequence number. The specified event will not be included. Instead, the next event is returned.
EventPosition	fromSequenceNumber(Long sequenceNumber, boolean inclusiveFlag) Creates a position at the given sequence number. The specified event will not be included. Instead, the next event is returned.
EventPosition	fromStartOfStream() Returns the position for the start of a stream. Provide this position in receiver creation to start receiving from the first available event in the partition.
Instant	getEnqueuedTime() Gets the enqueued time.
boolean	getInclusiveFlag() Gets the inclusive value.
String	getOffset() Gets the offset.
Long	getSequenceNumber() Gets the sequence number.

Method Details

fromEndOfStream

public static EventPosition fromEndOfStream()

Returns the position for the end of a stream. Provide this position in receiver creation to start receiving from the next available event in the partition after the receiver is created.

Returns:

An EventPosition set to the end of an Event Hubs stream.

fromEnqueuedTime

public static EventPosition fromEnqueuedTime(Instant dateTime)

Creates a position at the given Instant.

Parameters:

dateTime - is the enqueued time of the event.

Returns:

An EventPosition object.

fromOffset

public static EventPosition fromOffset(String offset)

Creates a position at the given offset. The specified event will not be included. Instead, the next event is returned.

Parameters:

offset - is the byte offset of the event.

Returns:

An EventPosition object.

fromOffset

public static EventPosition fromOffset(String offset, boolean inclusiveFlag)

Creates a position at the given offset.

Parameters:

offset - is the byte offset of the event.

inclusiveFlag - will include the specified event when set to true; otherwise, the next event is returned.

Returns:

An EventPosition object.

fromSequenceNumber

public static EventPosition fromSequenceNumber(Long sequenceNumber)

Creates a position at the given sequence number. The specified event will not be included. Instead, the next event is returned.

Parameters:

sequenceNumber - is the sequence number of the event.

Returns:

An EventPosition object.

fromSequenceNumber

public static EventPosition fromSequenceNumber(Long sequenceNumber, boolean inclusiveFlag)

Creates a position at the given sequence number. The specified event will not be included. Instead, the next event is returned.

Parameters:

sequenceNumber - is the sequence number of the event.

inclusiveFlag - will include the specified event when set to true; otherwise, the next event is returned.

Returns:

An EventPosition object.

fromStartOfStream

public static EventPosition fromStartOfStream()

Returns the position for the start of a stream. Provide this position in receiver creation to start receiving from the first available event in the partition.

Returns:

An EventPosition set to the start of an Event Hubs stream.

getEnqueuedTime

public Instant getEnqueuedTime()

Gets the enqueued time.

Returns:

the enqueued time.

getInclusiveFlag

public boolean getInclusiveFlag()

Gets the inclusive value.

Returns:

the inclusive value.

getOffset

public String getOffset()

Gets the offset.

Returns:

the offset.

getSequenceNumber

public Long getSequenceNumber()

Gets the sequence number.

Returns:

the sequence number.