Package org.apache.iceberg.actions

Interface Action<ThisT,R>

Type Parameters:
ThisT - the child Java API class, returned by method chaining
R - the Java type of the result produced by this action
All Known Subinterfaces:
ConvertEqualityDeleteFiles, DeleteOrphanFiles, DeleteReachableFiles, ExpireSnapshots, MigrateTable, RewriteDataFiles, RewriteManifests, RewritePositionDeleteFiles, SnapshotDeltaLakeTable, SnapshotTable, SnapshotUpdate<ThisT,R>, SnapshotUpdateAction<ThisT,R>
All Known Implementing Classes:
BaseRewriteDataFilesAction, DeleteOrphanFilesSparkAction, DeleteReachableFilesSparkAction, ExpireSnapshotsSparkAction, MigrateTableSparkAction, RewriteDataFilesAction, RewriteDataFilesSparkAction, RewriteManifestsSparkAction, RewritePositionDeleteFilesSparkAction, SnapshotTableSparkAction
public interface Action<ThisT,R>
An action performed on a table.

  • Method Summary

    Modifier and Type
    Method
    Description
    R
    execute()
    Executes this action.
    default ThisT
    option(String name, String value)
    Configures this action with an extra option.
    default ThisT
    options(Map<String,String> options)
    Configures this action with extra options.

  • Method Details

    • option

      default ThisT option(String name, String value)
      Configures this action with an extra option.

      Certain actions allow users to control internal details of their execution via options.

      Parameters:
      name - an option name
      value - an option value
      Returns:
      this for method chaining

    • options

      default ThisT options(Map<String,String> options)
      Configures this action with extra options.

      Certain actions allow users to control internal details of their execution via options.

      Parameters:
      options - a map of extra options
      Returns:
      this for method chaining

    • execute

      R execute()
      Executes this action.
      Returns:
      the result of this action