Package com.azure.spring.cloud.service.eventhubs.properties

Class StartPositionProperties

java.lang.Object

com.azure.spring.cloud.service.eventhubs.properties.StartPositionProperties

All Implemented Interfaces:

com.azure.spring.cloud.service.implementation.eventhubs.properties.EventProcessorClientProperties.StartPosition

public class StartPositionProperties
extends Object
implements com.azure.spring.cloud.service.implementation.eventhubs.properties.EventProcessorClientProperties.StartPosition

The starting position from which to consume events.

Constructor Summary

Constructors

Constructor	Description
StartPositionProperties()	Creates an instance of StartPositionProperties.

Method Summary

Modifier and Type	Method	Description
Instant	getEnqueuedDateTime()	The event enqueued after the requested enqueuedDateTime becomes the current position.
String	getOffset()	The offset of the event within that partition.
Long	getSequenceNumber()	The sequence number of the event within that partition.
boolean	isInclusive()	Whether the event of the specified sequence number is included.
void	setEnqueuedDateTime(Instant enqueuedDateTime)	Set the enqueued date time.
void	setInclusive(boolean inclusive)	Whether the position is inclusive.
void	setOffset(String offset)	Set the offset.
void	setSequenceNumber(Long sequenceNumber)	Set the sequence number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StartPositionProperties

public StartPositionProperties()

Creates an instance of StartPositionProperties.

Method Details

getOffset

public String getOffset()

Description copied from interface: com.azure.spring.cloud.service.implementation.eventhubs.properties.EventProcessorClientProperties.StartPosition

The offset of the event within that partition. String keyword, "earliest" and "latest" (case-insensitive), are reserved for specifying the start and end of the partition. Other provided value will be cast to Long.

Specified by:

getOffset in interface com.azure.spring.cloud.service.implementation.eventhubs.properties.EventProcessorClientProperties.StartPosition

Returns:

The offset of the event within that partition.

setOffset

public void setOffset(String offset)

Set the offset.

Parameters:

offset - The offset.

getSequenceNumber

public Long getSequenceNumber()

Description copied from interface: com.azure.spring.cloud.service.implementation.eventhubs.properties.EventProcessorClientProperties.StartPosition

The sequence number of the event within that partition.

Specified by:

getSequenceNumber in interface com.azure.spring.cloud.service.implementation.eventhubs.properties.EventProcessorClientProperties.StartPosition

Returns:

The sequence number of the event within that partition.

setSequenceNumber

public void setSequenceNumber(Long sequenceNumber)

Set the sequence number.

Parameters:

sequenceNumber - the sequence number.

getEnqueuedDateTime

public Instant getEnqueuedDateTime()

Description copied from interface: com.azure.spring.cloud.service.implementation.eventhubs.properties.EventProcessorClientProperties.StartPosition

The event enqueued after the requested enqueuedDateTime becomes the current position.

Specified by:

getEnqueuedDateTime in interface com.azure.spring.cloud.service.implementation.eventhubs.properties.EventProcessorClientProperties.StartPosition

Returns:

The enqueued datetime.

setEnqueuedDateTime

public void setEnqueuedDateTime(Instant enqueuedDateTime)

Set the enqueued date time.

Parameters:

enqueuedDateTime - The enqueued date time.

isInclusive

public boolean isInclusive()

Description copied from interface: com.azure.spring.cloud.service.implementation.eventhubs.properties.EventProcessorClientProperties.StartPosition

Whether the event of the specified sequence number is included.

Specified by:

isInclusive in interface com.azure.spring.cloud.service.implementation.eventhubs.properties.EventProcessorClientProperties.StartPosition

Returns:

Whether to include the specified event.

setInclusive

public void setInclusive(boolean inclusive)

Whether the position is inclusive.

Parameters:

inclusive - Whether the position is inclusive.