reactor.kafka.receiver.ReceiverPartition Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of reactor-kafka Show documentation
Reactor Kafka: A reactive API for Apache Kafka
There is a newer version: 1.3.23
/*
 * Copyright (c) 2016-2023 VMware Inc. or its affiliates, All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package reactor.kafka.receiver;

import org.apache.kafka.common.TopicPartition;
import reactor.util.annotation.Nullable;

/**
 * Topic partition interface that supports seek operations
 * that can be invoked when partitions are assigned.
 *
 */
public interface ReceiverPartition {

    /**
     * Returns the underlying Kafka topic partition.
     * @return topic partition
     */
    TopicPartition topicPartition();

    /**
     * Seeks to the first available offset of the topic partition. This overrides the offset
     * starting from which records are fetched.
     */
    void seekToBeginning();

    /**
     * Seeks to the last offset of the topic partition. This overrides the offset
     * starting from which records are fetched.
     */
    void seekToEnd();

    /**
     * Seeks to the specified offset of the topic partition. This overrides the offset
     * starting from which records are fetched.
     */
    void seek(long offset);

    /**
     * Seek to the topic partition offset that is greater than or equal to the timestamp.
     * If there are no matching records, {@link #seekToEnd()} is performed. See
     * {@link org.apache.kafka.clients.consumer.Consumer#offsetsForTimes(java.util.Map)}.
     * @param timestamp the timestamp.
     * @since 1.3.5
     */
    void seekToTimestamp(long timestamp);

    /**
     * Returns the offset of the next record that will be fetched from this topic partition.
     * @return current offset of this partition
     */
    long position();

    /**
     * Return the beginning offset for this partition.
     * @return the offset.
     * @see org.apache.kafka.clients.consumer.Consumer#beginningOffsets(java.util.Collection)
     * @since 1.3.19
     */
    @Nullable
    default Long beginningOffset() {
        return null;
    }

    /**
     * Return the end offset for this partition.
     * @return the offset.
     * @see org.apache.kafka.clients.consumer.Consumer#endOffsets(java.util.Collection)
     * @since 1.3.19
     */
    @Nullable
    default Long endOffset() {
        return null;
    }

}