BatchAsyncDataWriter.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 gobblin.writer;

import java.io.Closeable;
import java.io.IOException;
import java.util.concurrent.Future;

import javax.annotation.Nullable;
import gobblin.annotation.Alpha;

/**
 * An interface for implementing Async Writers for Gobblin.
 * The write only handles batched records
 */
@Alpha
public interface BatchAsyncDataWriter<D> extends Closeable {
  /**
   * Asynchronously write a record, execute the callback on success/failure
   */
  Future<WriteResponse> write(Batch<D> batch, @Nullable WriteCallback callback);

  /**
   * Flushes all pending batches
   */
  void flush()
      throws IOException;

}