runners/java-fn-execution/src/main/java/org/apache/beam/runners/fnexecution/control/BundleFinalizationHandler.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.beam.runners.fnexecution.control;

/**
 * A handler for the runner when a finalization request has been received.
 *
 * <p>The runner is responsible for finalizing the bundle when all output from the bundle has been
 * durably persisted.
 *
 * <p>See <a href="https://s.apache.org/beam-finalizing-bundles">finalizing bundles</a> for further
 * details.
 */
public interface BundleFinalizationHandler {
  /**
   * This callback is invoked whenever an inflight bundle that is being processed requests
   * finalization.
   *
   * <p>The runner is responsible for invoking bundle finalization when the output of the bundle has
   * been durably persisted.
   */
  void requestsFinalization(String bundleId);
}