/
PartitionLevelConsumer.java
70 lines (65 loc) · 2.96 KB
/
PartitionLevelConsumer.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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
*
* http://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 org.apache.pinot.spi.stream;
import java.io.Closeable;
import org.apache.pinot.spi.annotations.InterfaceAudience;
import org.apache.pinot.spi.annotations.InterfaceStability;
/**
* Interface for a consumer which fetches messages at the partition level of a stream, for given offsets
*/
@Deprecated
@InterfaceAudience.Public
@InterfaceStability.Stable
public interface PartitionLevelConsumer extends Closeable, PartitionGroupConsumer {
/**
* Is here for backward compatibility for a short time.
* TODO Issue 5359 remove this API once external kafka consumers implements return of StreamPartitionMsgOffset
* Fetch messages from the stream between the specified offsets
* @param startOffset
* @param endOffset
* @param timeoutMillis
* @return
* @throws java.util.concurrent.TimeoutException
*/
@Deprecated
default MessageBatch fetchMessages(long startOffset, long endOffset, int timeoutMillis)
throws java.util.concurrent.TimeoutException {
throw new UnsupportedOperationException();
}
/**
* Fetch messages and the per-partition high watermark from Kafka between the specified offsets.
*
* @param startOffset The offset of the first message desired, inclusive
* @param endOffset The offset of the last message desired, exclusive, or null
* @param timeoutMillis Timeout in milliseconds
* @throws java.util.concurrent.TimeoutException If the operation could not be completed within {@code timeoutMillis}
* milliseconds
* @return An iterable containing messages fetched from the stream partition and their offsets, as well as the
* high watermark for this partition.
*/
@Deprecated
default MessageBatch fetchMessages(StreamPartitionMsgOffset startOffset, StreamPartitionMsgOffset endOffset,
int timeoutMillis)
throws java.util.concurrent.TimeoutException {
// TODO Issue 5359 remove this default implementation once all kafka consumers have migrated to use this API
long startOffsetLong = ((LongMsgOffset) startOffset).getOffset();
long endOffsetLong = endOffset == null ? Long.MAX_VALUE : ((LongMsgOffset) endOffset).getOffset();
return fetchMessages(startOffsetLong, endOffsetLong, timeoutMillis);
}
}