Package com.azure.messaging.eventhubs.models

Class EventBatchContext

java.lang.Object

com.azure.messaging.eventhubs.models.EventBatchContext

public class EventBatchContext
extends Object

A class that contains a batch of EventData and the partition information the event batch belongs to. This is given to the EventProcessorClientBuilder.processEventBatch(Consumer, int) and EventProcessorClientBuilder.processEventBatch(Consumer, int, Duration) handlers each time an event batch is received from the Event Hub. This class also includes methods to update checkpoint in CheckpointStore and retrieve the last enqueued event information.

See Also:

• EventProcessorClientBuilder.processEventBatch(Consumer, int)
• EventProcessorClientBuilder.processEventBatch(Consumer, int, Duration)

Constructor Summary

Constructors

Constructor	Description
EventBatchContext(PartitionContext partitionContext, List<EventData> events, CheckpointStore checkpointStore, LastEnqueuedEventProperties lastEnqueuedEventProperties)	Creates an instance of EventBatchContext.

Method Summary

Modifier and Type	Method	Description
List<EventData>	getEvents()	Returns a list of event data received from Event Hub.
LastEnqueuedEventProperties	getLastEnqueuedEventProperties()	Returns the properties of the last enqueued event in this partition.
PartitionContext	getPartitionContext()	Returns the partition information associated with the received event.
void	updateCheckpoint()	Updates the checkpoint synchronously for this partition using the last event in the list provided by getEvents().
Mono<Void>	updateCheckpointAsync()	Updates the checkpoint asynchronously for this partition using the last event in the list provided by getEvents().

Methods inherited from class java.lang.Object

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

Constructor Details

EventBatchContext

public EventBatchContext(PartitionContext partitionContext,
 List<EventData> events,
 CheckpointStore checkpointStore,
 LastEnqueuedEventProperties lastEnqueuedEventProperties)

Creates an instance of EventBatchContext.

Parameters:

partitionContext - The partition information associated with the received event.

events - The list of events received from Event Hub.

checkpointStore - The checkpoint store that is used for updating checkpoints.

lastEnqueuedEventProperties - The properties of the last enqueued event in this partition. If EventProcessorClientBuilder.trackLastEnqueuedEventProperties(boolean) is set to false, this will be null.

Throws:

NullPointerException - If partitionContext, events, or checkpointStore is null.

Method Details

getPartitionContext

public PartitionContext getPartitionContext()

Returns the partition information associated with the received event.

Returns:

The partition information of the received event.

getEvents

public List<EventData> getEvents()

Returns a list of event data received from Event Hub. An empty list can be returned if EventProcessorClientBuilder.processEventBatch(Consumer, int, Duration) was used to construct the processor. This means that no events were received during the specified duration.

Returns:

The list of event data received from Event Hub.

getLastEnqueuedEventProperties

public LastEnqueuedEventProperties getLastEnqueuedEventProperties()

Returns the properties of the last enqueued event in this partition. If EventProcessorClientBuilder.trackLastEnqueuedEventProperties(boolean) is set to false or if getEvents() is empty, this method will return null.

Returns:

The properties of the last enqueued event in this partition. If EventProcessorClientBuilder.trackLastEnqueuedEventProperties(boolean) is set to false or if getEvents() is empty, this method will return null.

updateCheckpointAsync

public Mono<Void> updateCheckpointAsync()

Updates the checkpoint asynchronously for this partition using the last event in the list provided by getEvents(). This will serve as the last known successfully processed event in this partition if the update is successful. If getEvents() returns an empty, no update to checkpoint will be done.

Returns:

Gets a Mono that completes when the checkpoint is updated.

updateCheckpoint

public void updateCheckpoint()

Updates the checkpoint synchronously for this partition using the last event in the list provided by getEvents(). This will serve as the last known successfully processed event in this partition if the update is successful. If getEvents() returns an empty, no update to checkpoint will be done.