kafka.server

Interface TierStateMachine

All Known Implementing Classes:

ReplicaAlterLogDirsTierStateMachine, ReplicaFetcherTierStateMachine

public interface TierStateMachine

This interface defines the APIs needed to handle any state transitions related to tiering

Method Summary

Modifier and Type	Method and Description
Optional<kafka.server.PartitionFetchState>	maybeAdvanceState(org.apache.kafka.common.TopicPartition topicPartition, kafka.server.PartitionFetchState currentFetchState) Optionally advance the state of the tier state machine, based on the current PartitionFetchState.
kafka.server.PartitionFetchState	start(org.apache.kafka.common.TopicPartition topicPartition, kafka.server.PartitionFetchState currentFetchState, org.apache.kafka.common.message.FetchResponseData.PartitionData fetchPartitionData) Start the tier state machine for the provided topic partition.

Method Detail

start

kafka.server.PartitionFetchState start(org.apache.kafka.common.TopicPartition topicPartition,
                                       kafka.server.PartitionFetchState currentFetchState,
                                       org.apache.kafka.common.message.FetchResponseData.PartitionData fetchPartitionData)
                                throws Exception

Start the tier state machine for the provided topic partition.

Parameters:

topicPartition - the topic partition

currentFetchState - the current PartitionFetchState which will be used to derive the return value

fetchPartitionData - the data from the fetch response that returned the offset moved to tiered storage error

Returns:

the new PartitionFetchState after the successful start of the tier state machine

Throws:

Exception

maybeAdvanceState

Optional<kafka.server.PartitionFetchState> maybeAdvanceState(org.apache.kafka.common.TopicPartition topicPartition,
                                                             kafka.server.PartitionFetchState currentFetchState)

Optionally advance the state of the tier state machine, based on the current PartitionFetchState. The decision to advance the tier state machine is implementation specific.

Parameters:

topicPartition - the topic partition

currentFetchState - the current PartitionFetchState which will be used to derive the return value

Returns:

the new PartitionFetchState if the tier state machine was advanced, otherwise, return the currentFetchState