com.azure.messaging.eventhubs.models

Class InitializationContext

java.lang.Object

com.azure.messaging.eventhubs.models.InitializationContext

public class InitializationContext
extends Object

The initialization context that is supplied to EventProcessorClientBuilder.processPartitionInitialization(Consumer) before the EventProcessorClient instance begins processing events from a partition.

Constructor Summary

Constructors

Constructor and Description
InitializationContext(PartitionContext partitionContext, EventPosition initialPosition) Creates an instance of InitializationContext for the partition provided in the PartitionContext.

Method Summary

Modifier and Type	Method and Description
EventPosition	getInitialPosition() Returns the default initial event position from which the processing will start in the absence of a checkpoint in CheckpointStore.
PartitionContext	getPartitionContext() Returns the partition information for which the event processing is going to start.
void	setInitialPosition(EventPosition initialPosition) If a different initial position is desirable for this partition, setting the initial position will start the event processing from this position.

Methods inherited from class java.lang.Object

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

Constructor Detail

InitializationContext

public InitializationContext(PartitionContext partitionContext,
                             EventPosition initialPosition)

Creates an instance of InitializationContext for the partition provided in the PartitionContext.

Parameters:

partitionContext - The partition information for which the event processing is going to start.

initialPosition - The default initial event position from which the processing will start in the absence of a checkpoint in CheckpointStore.

Throws:

NullPointerException - if partitionContext or initialPositionis null.

Method Detail

getPartitionContext

public PartitionContext getPartitionContext()

Returns the partition information for which the event processing is going to start.

Returns:

The partition information for which the event processing is going to start.

getInitialPosition

public EventPosition getInitialPosition()

Returns the default initial event position from which the processing will start in the absence of a checkpoint in CheckpointStore.

Returns:

The default initial event position from which the processing will start in the absence of a checkpoint in CheckpointStore.

setInitialPosition

public void setInitialPosition(EventPosition initialPosition)

If a different initial position is desirable for this partition, setting the initial position will start the event processing from this position. Note that the checkpoint in CheckpointStore is given the highest priority and if there's a checkpoint in the store, that will be used regardless of what is set in this method.

Parameters:

initialPosition - The initial event position to start the event processing from.

Throws:

NullPointerException - if initialPosition is null.