Package io.debezium.heartbeat

Interface Heartbeat

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

Heartbeat.ScheduledHeartbeat

All Known Implementing Classes:

CompositeHeartbeat, DatabaseHeartbeatImpl, HeartbeatImpl

public interface Heartbeat
extends AutoCloseable

A class that is able to emit heartbeat messages. The clients are supposed to call method emit(Map, OffsetContext) from a main loop of a connector.

Author:

Jiri Pechanec

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Heartbeat.OffsetProducer	Returns the offset to be used when emitting a heartbeat event.
static interface	Heartbeat.ScheduledHeartbeat	A class that is able to generate periodic heartbeat messages based on a pre-configured interval.

Field Summary

Fields

Modifier and Type	Field	Description
static final Heartbeat	DEFAULT_NOOP_HEARTBEAT	No-op Heartbeat implementation (not enabled)
static final io.debezium.config.Field	HEARTBEAT_INTERVAL
static final String	HEARTBEAT_INTERVAL_PROPERTY_NAME
static final io.debezium.config.Field	HEARTBEAT_TOPICS_PREFIX

Method Summary

Modifier and Type	Method	Description
default void	close()
default void	emit(Map<String,?> partition, OffsetContext offset)	Generates a heartbeat record unconditionally
default void	forcedBeat(Map<String,?> partition, Map<String,?> offset, BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)	Deprecated.
default void	heartbeat(Map<String,?> partition, Heartbeat.OffsetProducer offsetProducer, BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)	Deprecated.
default void	heartbeat(Map<String,?> partition, Map<String,?> offset, BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)	Deprecated.
boolean	isEnabled()	Whether heartbeats are enabled or not.

Field Details

HEARTBEAT_INTERVAL_PROPERTY_NAME

static final String HEARTBEAT_INTERVAL_PROPERTY_NAME

See Also:

• Constant Field Values

HEARTBEAT_INTERVAL

static final io.debezium.config.Field HEARTBEAT_INTERVAL

HEARTBEAT_TOPICS_PREFIX

static final io.debezium.config.Field HEARTBEAT_TOPICS_PREFIX

DEFAULT_NOOP_HEARTBEAT

static final Heartbeat DEFAULT_NOOP_HEARTBEAT

No-op Heartbeat implementation (not enabled)

Method Details

heartbeat

@Deprecated
default void heartbeat(Map<String,?> partition,
 Map<String,?> offset,
 BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)
                throws InterruptedException

Deprecated.

Generates a heartbeat record if defined time has elapsed Replaced by Heartbeat.ScheduledHeartbeat.emitWithDelay(Map, OffsetContext)

Parameters:

partition - partition for the heartbeat record

offset - offset for the heartbeat record

consumer - - a code to place record among others to be sent into Connect

Throws:

InterruptedException

heartbeat

@Deprecated
default void heartbeat(Map<String,?> partition,
 Heartbeat.OffsetProducer offsetProducer,
 BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)
                throws InterruptedException

Deprecated.

Generates a heartbeat record if defined time has elapsed Replaced by Heartbeat.ScheduledHeartbeat.emitWithDelay(Map, OffsetContext)

Parameters:

partition - partition for the heartbeat record

offsetProducer - lazily calculated offset for the heartbeat record

consumer - - a code to place record among others to be sent into Connect

Throws:

InterruptedException

forcedBeat

@Deprecated
default void forcedBeat(Map<String,?> partition,
 Map<String,?> offset,
 BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)
                 throws InterruptedException

Deprecated.

Generates a heartbeat record unconditionally Replaced by emit(Map, OffsetContext)

Parameters:

partition - partition for the heartbeat record

offset - offset for the heartbeat record

consumer - - a code to place record among others to be sent into Connect

Throws:

InterruptedException

emit

default void emit(Map<String,?> partition,
 OffsetContext offset)
           throws InterruptedException

Generates a heartbeat record unconditionally

Parameters:

partition - partition for the heartbeat record

offset - offset for the heartbeat record

Throws:

InterruptedException

isEnabled

boolean isEnabled()

Whether heartbeats are enabled or not.

close

default void close()

Specified by:

close in interface AutoCloseable