Package com.azure.messaging.eventhubs.models

Class EventContext

java.lang.Object

com.azure.messaging.eventhubs.models.EventContext

public class EventContext
extends Object

A class that contains EventData and the partition information the event belongs to. This is given to the processEvent and EventProcessorClientBuilder.processEvent(Consumer, Duration) handlers each time an event is received from the Event Hub or when the maxWaitTime duration has elapsed. This class also includes methods to update checkpoint in CheckpointStore and retrieve the last enqueued event information.

Constructor Summary

Constructors

Constructor	Description
EventContext(PartitionContext partitionContext, EventData eventData, CheckpointStore checkpointStore, LastEnqueuedEventProperties lastEnqueuedEventProperties)	Creates an instance of EventContext.

Method Summary

Modifier and Type	Method	Description
EventData	getEventData()	Returns the 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 event data.
Mono<Void>	updateCheckpointAsync()	Updates the checkpoint asynchronously for this partition using the event data in this EventContext.

Methods inherited from class java.lang.Object

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

Constructor Details

EventContext

public EventContext(PartitionContext partitionContext,
 EventData eventData,
 CheckpointStore checkpointStore,
 LastEnqueuedEventProperties lastEnqueuedEventProperties)

Creates an instance of EventContext.

Parameters:

partitionContext - The partition information associated with the received event.

eventData - The event 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, eventData 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.

getEventData

public EventData getEventData()

Returns the event data received from Event Hub. Can be null if EventProcessorClientBuilder.processEvent(Consumer, Duration) was used to construct the processor. This means that no event was received during the specified duration.

Returns:

The event data received from Event Hub or null.

getLastEnqueuedEventProperties

public LastEnqueuedEventProperties getLastEnqueuedEventProperties()

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

Returns:

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

updateCheckpointAsync

public Mono<Void> updateCheckpointAsync()

Updates the checkpoint asynchronously for this partition using the event data in this EventContext. This will serve as the last known successfully processed event in this partition if the update is successful.

Returns:

A representation of deferred execution of this call.

updateCheckpoint

public void updateCheckpoint()

Updates the checkpoint synchronously for this partition using the event data. This will serve as the last known successfully processed event in this partition if the update is successful.