read/streaming/ReadLimit.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.sql.connector.read.streaming;
0019
0020 import org.apache.spark.annotation.Evolving;
0021
0022 /**
0023  * Interface representing limits on how much to read from a {@link MicroBatchStream} when it
0024  * implements {@link SupportsAdmissionControl}. There are several child interfaces representing
0025  * various kinds of limits.
0026  *
0027  * @see SupportsAdmissionControl#latestOffset(Offset, ReadLimit)
0028  * @see ReadAllAvailable
0029  * @see ReadMaxRows
0030  * @since 3.0.0
0031  */
0032 @Evolving
0033 public interface ReadLimit {
0034   static ReadLimit maxRows(long rows) { return new ReadMaxRows(rows); }
0035
0036   static ReadLimit maxFiles(int files) { return new ReadMaxFiles(files); }
0037
0038   static ReadLimit allAvailable() { return ReadAllAvailable.INSTANCE; }
0039 }