io.whitfin.elasticsearch.bulk.BulkLifecycle Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch-bulk-operator Show documentation

Elasticsearch bulk implementation using the REST client.

The newest version!

package io.whitfin.elasticsearch.bulk;

import co.elastic.clients.elasticsearch.core.BulkRequest;
import co.elastic.clients.elasticsearch.core.BulkResponse;
import org.elasticsearch.client.Response;

/**
 * Lifecycle interface for bulk execution, providing the ability to
 * hook into various stages of bulk execution.
 *
 * This interface is required as executions happen in a separate thread
 * so there's no way to implement your own logging. The same execution
 * can be correlated via the `executionId` passed as first argument into
 * all callback functions in this interface.
 */
public interface BulkLifecycle {

    /**
     * Executes prior to the bulk request being forwarded to Elasticsearch.
     *
     * @param executionId
     *      the bulk execution identifier.
     * @param operator
     *      the {@link BulkOperator} carrying out the request.
     * @param request
     *      the {@link BulkRequest} being executed.
     */
    void beforeBulk(long executionId, BulkOperator operator, BulkRequest request);

    /**
     * Executes after a bulk execution.
     *
     * Note that this only means a successful request, not necessarily
     * a successful bulk execution.
     *
     * @param executionId
     *      the bulk execution identifier.
     * @param operator
     *      the {@link BulkOperator} carrying out the request.
     * @param request
     *      the {@link BulkRequest} being executed.
     * @param response
     *      the response returned by the execution.
     */
    void afterBulk(long executionId, BulkOperator operator, BulkRequest request, BulkResponse response);

    /**
     * Executes after a failed bulk execution.
     *]
     * @param executionId
     *      the bulk execution identifier.
     * @param operator
     *      the {@link BulkOperator} carrying out the request.
     * @param request
     *      the {@link BulkRequest} being executed.
     * @param failure
     *      the {@link Throwable} caught during execution.
     */
    void afterBulk(long executionId, BulkOperator operator, BulkRequest request, Throwable failure);
}