metron-platform/metron-elasticsearch/metron-elasticsearch-common/src/main/java/org/apache/metron/elasticsearch/bulk/BulkDocumentWriter.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.metron.elasticsearch.bulk;

import org.apache.metron.indexing.dao.update.Document;

/**
 * Writes documents to an index in bulk.
 *
 * @param <D> The type of document to write.
 */
public interface BulkDocumentWriter<D extends Document> {

    /**
     * Add a document to the batch.
     * @param document The document to write.
     * @param index The name of the index to write to.
     */
    void addDocument(D document, String index);

    /**
     * @return The number of documents waiting to be written.
     */
    int size();

    /**
     * Write all documents in the batch.
     */
    BulkDocumentWriterResults<D> write();
}