Package com.azure.spring.messaging.eventhubs.core.checkpoint

Enum CheckpointMode

java.lang.Object

java.lang.Enum<CheckpointMode>

com.azure.spring.messaging.eventhubs.core.checkpoint.CheckpointMode

All Implemented Interfaces:

Serializable, Comparable<CheckpointMode>, java.lang.constant.Constable

public enum CheckpointMode
extends Enum<CheckpointMode>

The offset commit behavior enumeration.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BATCH	Checkpoint after each processed batch of records.
MANUAL	User decide when to checkpoint manually
PARTITION_COUNT	Checkpoint once for number of message specified by CheckpointConfig.getCount() ()} in each partition
RECORD	Checkpoint after each processed record.
TIME	Checkpoint once for each time interval specified by CheckpointConfig.getInterval() ()}

Method Summary

Modifier and Type	Method	Description
static CheckpointMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CheckpointMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RECORD

public static final CheckpointMode RECORD

Checkpoint after each processed record. Makes sense only if ListenerMode.RECORD is used.

BATCH

public static final CheckpointMode BATCH

Checkpoint after each processed batch of records.

MANUAL

public static final CheckpointMode MANUAL

User decide when to checkpoint manually

PARTITION_COUNT

public static final CheckpointMode PARTITION_COUNT

Checkpoint once for number of message specified by CheckpointConfig.getCount() ()} in each partition

TIME

public static final CheckpointMode TIME

Checkpoint once for each time interval specified by CheckpointConfig.getInterval() ()}

Method Details

values

public static CheckpointMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CheckpointMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null