read/streaming/ReadMaxRows.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  * Represents a {@link ReadLimit} where the {@link MicroBatchStream} should scan approximately the
0024  * given maximum number of rows.
0025  *
0026  * @see SupportsAdmissionControl#latestOffset(Offset, ReadLimit)
0027  * @since 3.0.0
0028  */
0029 @Evolving
0030 public final class ReadMaxRows implements ReadLimit {
0031   private long rows;
0032
0033   ReadMaxRows(long rows) {
0034     this.rows = rows;
0035   }
0036
0037   /** Approximate maximum rows to scan. */
0038   public long maxRows() { return this.rows; }
0039
0040   @Override
0041   public String toString() {
0042     return "MaxRows: " + maxRows();
0043   }
0044
0045   @Override
0046   public boolean equals(Object o) {
0047     if (this == o) return true;
0048     if (o == null || getClass() != o.getClass()) return false;
0049     ReadMaxRows other = (ReadMaxRows) o;
0050     return other.maxRows() == maxRows();
0051   }
0052
0053   @Override
0054   public int hashCode() { return Long.hashCode(this.rows); }
0055 }