org.elasticsearch.xpack.core.indexing.IterationResult Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of x-pack-core Show documentation

Elasticsearch Expanded Pack Plugin - Core

There is a newer version: 8.13.2

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */

package org.elasticsearch.xpack.core.indexing;

import org.elasticsearch.action.index.IndexRequest;

import java.util.List;

/**
 * Result object to hold the result of 1 iteration of iterative indexing.
 * Acts as an interface between the implementation and the generic indexer.
 */
public class IterationResult {

    private final boolean isDone;
    private final JobPosition position;
    private final List toIndex;

    /**
     * Constructor for the result of 1 iteration.
     *
     * @param toIndex the list of requests to be indexed
     * @param position the extracted, persistable position of the job required for the search phase
     * @param isDone true if source is exhausted and job should go to sleep
     *
     * Note: toIndex.empty() != isDone due to possible filtering in the specific implementation
     */
    public IterationResult(List toIndex, JobPosition position, boolean isDone) {
        this.toIndex = toIndex;
        this.position = position;
        this.isDone = isDone;
    }

    /**
     * Returns true if this indexing iteration is done and job should go into sleep mode.
     */
    public boolean isDone() {
        return isDone;
    }

    /**
     * Return the position of the job, a generic to be passed to the next query construction.
     *
     * @return the position
     */
    public JobPosition getPosition() {
        return position;
    }

    /**
     * List of requests to be passed to bulk indexing.
     *
     * @return List of index requests.
     */
    public List getToIndex() {
        return toIndex;
    }
}