/*
 * 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.hudi.table.action.index;

import org.apache.hudi.common.table.timeline.HoodieInstant;

import java.io.IOException;

/**
 * Indexing check runs for instants that completed after the base instant (in the index plan).
 * This interface can be implemented to do the check and update the index depending on the index type.
 * For example, {@link WriteStatBasedIndexingCatchupTask} is used for commit metadata based indexing,
 * while {@link RecordBasedIndexingCatchupTask} is used for record level indexing.
 */
public interface IndexingCatchupTask extends Runnable {

  /**
   * Update the index for the write action.
   *
   * @param instant Hoodie instant corresponding to the write action
   */
  void updateIndexForWriteAction(HoodieInstant instant) throws IOException;
}
