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

Class CheckpointConfig

java.lang.Object

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

public class CheckpointConfig
extends Object

Checkpoint config to describe different checkpoint strategies.

Constructor Summary

Constructors

Constructor	Description
CheckpointConfig()	Construct a CheckpointConfig with the CheckpointMode.RECORD mode.
CheckpointConfig(CheckpointMode mode)	Construct a CheckpointConfig with the specified CheckpointMode mode.
CheckpointConfig(CheckpointMode mode, Integer count)	Construct a CheckpointConfig with the specified CheckpointMode mode and the amount of messages for each partition to do one checkpoint.
CheckpointConfig(CheckpointMode mode, Integer count, Duration interval)	Construct a CheckpointConfig with the specified CheckpointMode mode, the amount of messages for each partition to do one checkpoint and the time interval to do one checkpoint.
CheckpointConfig(CheckpointMode mode, Duration duration)	Construct a CheckpointConfig with the specified CheckpointMode mode and the time interval to do one checkpoint.

Method Summary

Modifier and Type	Method	Description
Integer	getCount()	Get the amount of message for each partition to do one checkpoint.
Duration	getInterval()	Get the time interval to do one checkpoint.
CheckpointMode	getMode()	Get the checkpoint mode.
void	setCount(Integer count)	Set the amount of message for each partition to do one checkpoint.
void	setInterval(Duration interval)	Set the time interval to do one checkpoint.
void	setMode(CheckpointMode mode)	Set the checkpoint mode.

Methods inherited from class java.lang.Object

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

Constructor Details

CheckpointConfig

public CheckpointConfig()

Construct a CheckpointConfig with the CheckpointMode.RECORD mode.

CheckpointConfig

public CheckpointConfig(CheckpointMode mode)

Construct a CheckpointConfig with the specified CheckpointMode mode.

Parameters:

mode - the checkpoint mode.

CheckpointConfig

public CheckpointConfig(CheckpointMode mode,
 Integer count)

Construct a CheckpointConfig with the specified CheckpointMode mode and the amount of messages for each partition to do one checkpoint.

Parameters:

mode - the specified CheckpointMode mode.

count - the amount of messages for each partition to do one checkpoint, it will be effective only when CheckpointMode.PARTITION_COUNT is configured.

CheckpointConfig

public CheckpointConfig(CheckpointMode mode,
 Duration duration)

Construct a CheckpointConfig with the specified CheckpointMode mode and the time interval to do one checkpoint.

Parameters:

mode - the specified CheckpointMode mode.

duration - the time interval to do one checkpoint, it will be effective only when CheckpointMode.TIME is configured.

CheckpointConfig

public CheckpointConfig(CheckpointMode mode,
 Integer count,
 Duration interval)

Construct a CheckpointConfig with the specified CheckpointMode mode, the amount of messages for each partition to do one checkpoint and the time interval to do one checkpoint.

Parameters:

mode - the specified CheckpointMode mode.

count - the amount of messages for each partition to do one checkpoint, it will be effective only when CheckpointMode.PARTITION_COUNT is configured.

interval - the time interval to do one checkpoint, it will be effective only when CheckpointMode.TIME is configured.

Method Details

getMode

public CheckpointMode getMode()

Get the checkpoint mode.

Returns:

the checkpoint mode.

setMode

public void setMode(CheckpointMode mode)

Set the checkpoint mode.

Parameters:

mode - the checkpoint mode.

getCount

public Integer getCount()

Get the amount of message for each partition to do one checkpoint.

Returns:

the amount of message for each partition to do one checkpoint.

setCount

public void setCount(Integer count)

Set the amount of message for each partition to do one checkpoint.

Parameters:

count - the amount of message for each partition to do one checkpoint.

getInterval

public Duration getInterval()

Get the time interval to do one checkpoint.

Returns:

the time interval to do one checkpoint.

setInterval

public void setInterval(Duration interval)

Set the time interval to do one checkpoint.

Parameters:

interval - the time interval to do one checkpoint.