org.apache.iceberg.actions.SnapshotUpdate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of iceberg-api Show documentation

A table format for huge analytic datasets

The newest version!

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

import org.apache.iceberg.Snapshot;

/**
 * An action that produces snapshots. This interface contains common methods for all
 * actions that create a new {@link Snapshot}.
 *
 * @param  the child Java API class, returned by method chaining
 * @param  the Java type of the result produced by this action
 */
public interface SnapshotUpdate extends Action {
  /**
   * Sets a summary property in the snapshot produced by this action.
   *
   * @param property a snapshot property name
   * @param value a snapshot property value
   * @return this for method chaining
   */
  ThisT snapshotProperty(String property, String value);
}