io.evitadb.api.task.Task Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of evita_api Show documentation

Module contains external API of the evitaDB.

The newest version!

/*
 *
 *                         _ _        ____  ____
 *               _____   _(_) |_ __ _|  _ \| __ )
 *              / _ \ \ / / | __/ _` | | | |  _ \
 *             |  __/\ V /| | || (_| | |_| | |_) |
 *              \___| \_/ |_|\__\__,_|____/|____/
 *
 *   Copyright (c) 2024
 *
 *   Licensed under the Business Source License, Version 1.1 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   https://github.com/FgForrest/evitaDB/blob/master/LICENSE
 *
 *   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 io.evitadb.api.task;

import javax.annotation.Nonnull;
import java.util.concurrent.CompletableFuture;

/**
 * Interface for different tasks that can be executed in the background service. It represents an instance of single
 * task execution with particular settings executed by the service thread pool with lower priority on the background.
 *
 * @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2024
 */
public interface Task {

	/**
	 * Returns actual status of the task, telemetry information and access to its progress, settings and result.
	 * @return The status of the task.
	 */
	@Nonnull
	TaskStatus getStatus();

	/**
	 * Returns the future result of the task. The future is completed when the task is finished.
	 * @return The future result of the task.
	 */
	@Nonnull
	CompletableFuture getFutureResult();

	/**
	 * Cancels the task.
	 *
	 * @return True if the task was successfully canceled, false if the task is already finished or canceled.
	 */
	boolean cancel();

}