Class PushReplicationEvent<T>

java.lang.Object

io.confluent.kafka.replication.push.buffer.PushReplicationEvent<T>

public final class PushReplicationEvent<T>
extends Object

A generic event representing a partition replica change that should be processed for the purposes of push replication.

There are different types of these events corresponding to starting push replication, stopping push replication, the various types of partition updates - a newly appended records batch, an updated HWM, or an updated LSO that might be needed to have a follower catch up.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PushReplicationEvent.OffsetPayload	A payload carrying a single offset value.
static class	PushReplicationEvent.RecordsPayload	A payload carrying an AbstractRecords representing some records already appended on the partition replica leader, their append offset, and the high watermark value at the time of creating the records.
static enum	PushReplicationEvent.Type	Enumerates the different types of push replication events.

Method Summary

Modifier and Type	Method	Description
long	eventCreatedTimeMs()
static PushReplicationEvent<PushReplicationEvent.OffsetPayload>	forHighWatermarkUpdate(org.apache.kafka.server.common.TopicIdPartition topicIdPartition, int replicaId, long updatedHighWatermark, long eventCreatedTimeMs)	Creates a new event of type PushReplicationEvent.Type.HWM_UPDATE with its payload being an PushReplicationEvent.OffsetPayload containing the updated high watermark.
static PushReplicationEvent<PushReplicationEvent.OffsetPayload>	forLogStartOffsetUpdate(org.apache.kafka.server.common.TopicIdPartition topicIdPartition, int replicaId, long updatedLogStartOffset, long eventCreatedTimeMs)	Creates a new event of type PushReplicationEvent.Type.LSO_UPDATE with its payload being an PushReplicationEvent.OffsetPayload containing the updated log start offset.
static PushReplicationEvent<PushReplicationEvent.RecordsPayload>	forRecords(org.apache.kafka.server.common.TopicIdPartition topicIdPartition, int replicaId, org.apache.kafka.common.record.AbstractRecords records, long appendOffset, long eventCreatedTimeMs)	Creates a new event of type PushReplicationEvent.Type.MEMORY_RECORDS with its payload being a PushReplicationEvent.RecordsPayload containing the given records and offsets.
static PushReplicationEvent<PushSession>	forStartPush(org.apache.kafka.server.common.TopicIdPartition topicIdPartition, PushSession pushSession, long eventCreatedTimeMs)	Creates a new event of type PushReplicationEvent.Type.START_PUSH with its payload being the given PushSession.
static PushReplicationEvent<PushSessionEndReason>	forStopPush(org.apache.kafka.server.common.TopicIdPartition topicIdPartition, int replicaId, PushSessionEndReason pushSessionEndReason, long eventCreatedTimeMs)	Creates a new event of type PushReplicationEvent.Type.STOP_PUSH with its payload being a PushSessionEndReason.
T	payload()	The payload carried by this push replication event.
int	replicaId()
org.apache.kafka.server.common.TopicIdPartition	topicIdPartition()
String	toString()
PushReplicationEvent.Type	type()	The type of this push replication event.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

forStartPush

public static PushReplicationEvent<PushSession> forStartPush(org.apache.kafka.server.common.TopicIdPartition topicIdPartition,
 PushSession pushSession,
 long eventCreatedTimeMs)

Creates a new event of type PushReplicationEvent.Type.START_PUSH with its payload being the given PushSession.

forRecords

public static PushReplicationEvent<PushReplicationEvent.RecordsPayload> forRecords(org.apache.kafka.server.common.TopicIdPartition topicIdPartition,
 int replicaId,
 org.apache.kafka.common.record.AbstractRecords records,
 long appendOffset,
 long eventCreatedTimeMs)

Creates a new event of type PushReplicationEvent.Type.MEMORY_RECORDS with its payload being a PushReplicationEvent.RecordsPayload containing the given records and offsets.

forHighWatermarkUpdate

public static PushReplicationEvent<PushReplicationEvent.OffsetPayload> forHighWatermarkUpdate(org.apache.kafka.server.common.TopicIdPartition topicIdPartition,
 int replicaId,
 long updatedHighWatermark,
 long eventCreatedTimeMs)

Creates a new event of type PushReplicationEvent.Type.HWM_UPDATE with its payload being an PushReplicationEvent.OffsetPayload containing the updated high watermark.

forLogStartOffsetUpdate

public static PushReplicationEvent<PushReplicationEvent.OffsetPayload> forLogStartOffsetUpdate(org.apache.kafka.server.common.TopicIdPartition topicIdPartition,
 int replicaId,
 long updatedLogStartOffset,
 long eventCreatedTimeMs)

Creates a new event of type PushReplicationEvent.Type.LSO_UPDATE with its payload being an PushReplicationEvent.OffsetPayload containing the updated log start offset.

forStopPush

public static PushReplicationEvent<PushSessionEndReason> forStopPush(org.apache.kafka.server.common.TopicIdPartition topicIdPartition,
 int replicaId,
 PushSessionEndReason pushSessionEndReason,
 long eventCreatedTimeMs)

Creates a new event of type PushReplicationEvent.Type.STOP_PUSH with its payload being a PushSessionEndReason.

topicIdPartition

public org.apache.kafka.server.common.TopicIdPartition topicIdPartition()

replicaId

public int replicaId()

payload

public T payload()

The payload carried by this push replication event. The exact type of the payload depends on the exact type of the event.

type

public PushReplicationEvent.Type type()

The type of this push replication event.

See Also:

• PushReplicationEvent.Type

eventCreatedTimeMs

public long eventCreatedTimeMs()

toString

public String toString()

Overrides:

toString in class Object