api/src/main/java/org/apache/iceberg/ChangelogScanTask.java

/*
 * 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.iceberg;

/**
 * A changelog scan task.
 */
public interface ChangelogScanTask extends ScanTask {
  /**
   * Returns the type of changes produced by this task (i.e. insert/delete).
   */
  ChangelogOperation operation();

  /**
   * Returns the ordinal of changes produced by this task. This number indicates the order in which
   * changes produced by this scan must be applied. Operations with a lower ordinal must be applied first.
   */
  int changeOrdinal();

  /**
   * Returns the snapshot ID in which the changes were committed.
   */
  long commitSnapshotId();
}