Index

A B C E F G H L M O P S T U V W
All Classes and Interfaces|All Packages

A

ACTIVE - Enum constant in enum org.opensearch.task.commons.task.TaskStatus

TaskStatus of an in progress Task

ASSIGNED - Enum constant in enum org.opensearch.task.commons.task.TaskStatus

TaskStatus of a Task which is assigned to or picked up by a worker but hasn't started execution yet.

assignedAt(long) - Method in class org.opensearch.task.commons.task.Task.Builder

Set Task Assignment Time

assignedNode(WorkerNode) - Method in class org.opensearch.task.commons.task.Task.Builder

Set Task Assigned Node

assignTask(TaskId, WorkerNode) - Method in interface org.opensearch.task.commons.clients.TaskManagerClient

Assign Task to a particular WorkerNode.

B

build() - Method in class org.opensearch.task.commons.task.Task.Builder

Build Task from Builder

builder(Task) - Static method in class org.opensearch.task.commons.task.Task.Builder

Build Builder from Task

builder(TaskId, TaskStatus, TaskParams, TaskType, long) - Static method in class org.opensearch.task.commons.task.Task.Builder

Build Builder from various Task attributes

C

CANCELLED - Enum constant in enum org.opensearch.task.commons.task.TaskStatus

TaskStatus of a cancelled Task

cancelTask(TaskId) - Method in interface org.opensearch.task.commons.clients.TaskManagerClient

Mark task as cancelled.

completedAt(long) - Method in class org.opensearch.task.commons.task.Task.Builder

Set Task Completion Time

createWorkerNode(String, String, String) - Static method in class org.opensearch.task.commons.worker.WorkerNode

Creates a new worker node with the given ID, name, and IP address.

E

equals(Object) - Method in class org.opensearch.task.commons.task.TaskId

equals(Object) - Method in class org.opensearch.task.commons.worker.WorkerNode

executeTask(Task) - Method in interface org.opensearch.task.commons.worker.TaskWorker

Execute the Task

F

FAILED - Enum constant in enum org.opensearch.task.commons.task.TaskStatus

TaskStatus of a Task which failed in 1 or more attempts

G

getAssignedAt() - Method in class org.opensearch.task.commons.task.Task

Get Task Assignment Time

getAssignedNode() - Method in class org.opensearch.task.commons.task.Task

Get Task Assigned Node

getAssignedTasks(TaskListRequest) - Method in interface org.opensearch.task.commons.clients.TaskWorkerClient

List all tasks assigned to a WorkerNode.

getCompletedAt() - Method in class org.opensearch.task.commons.task.Task

Get Task Completion Time

getCreatedAt() - Method in class org.opensearch.task.commons.task.Task

Get Task Creation Time

getId() - Method in class org.opensearch.task.commons.worker.WorkerNode

Returns the unique identifier of the worker node.

getIp() - Method in class org.opensearch.task.commons.worker.WorkerNode

Returns the IP address of the worker node.

getLastHeartbeatAt() - Method in class org.opensearch.task.commons.task.Task

Get Last Heartbeat Time

getName() - Method in class org.opensearch.task.commons.worker.WorkerNode

Returns the name of the worker node.

getParams() - Method in class org.opensearch.task.commons.task.Task

Get TaskParams

getStartedAt() - Method in class org.opensearch.task.commons.task.Task

Get Task Start Time

getTask(TaskId) - Method in interface org.opensearch.task.commons.clients.TaskManagerClient

Get task from TaskStore/Queue

getTaskId() - Method in class org.opensearch.task.commons.task.Task

Get TaskId

getTaskStatus() - Method in class org.opensearch.task.commons.task.Task

Get TaskStatus

getTaskType() - Method in class org.opensearch.task.commons.task.Task

Get TaskType

getValue() - Method in class org.opensearch.task.commons.task.TaskId

Get id value

H

hashCode() - Method in class org.opensearch.task.commons.task.TaskId

hashCode() - Method in class org.opensearch.task.commons.worker.WorkerNode

L

lastHeartbeatAt(long) - Method in class org.opensearch.task.commons.task.Task.Builder

Set Task Last Heartbeat Time for the task

listTasks(TaskListRequest) - Method in interface org.opensearch.task.commons.clients.TaskManagerClient

List all tasks applying all the filters present in listTaskRequest

M

MERGE - Enum constant in enum org.opensearch.task.commons.task.TaskType

For all segment merge related tasks

O

org.opensearch.task.commons.clients - package org.opensearch.task.commons.clients

Contains task client related classes

org.opensearch.task.commons.task - package org.opensearch.task.commons.task

Contains tasks related classes

org.opensearch.task.commons.worker - package org.opensearch.task.commons.worker

Contains task worker related classes

P

pageSize(int) - Method in class org.opensearch.task.commons.clients.TaskListRequest

Update page size for the list tasks response

S

sendTaskHeartbeat(TaskId, long) - Method in interface org.opensearch.task.commons.clients.TaskWorkerClient

Sends task heart beat to Task Store/Queue

SNAPSHOT - Enum constant in enum org.opensearch.task.commons.task.TaskType

For all snapshot related tasks

startedAt(long) - Method in class org.opensearch.task.commons.task.Task.Builder

Set Task Start Time

startPageNumber(int) - Method in class org.opensearch.task.commons.clients.TaskListRequest

Update page number to start with when fetching the list of tasks

submitTask(Task) - Method in interface org.opensearch.task.commons.clients.TaskProducerClient

Submit a new task to TaskStore/Queue

SUCCESS - Enum constant in enum org.opensearch.task.commons.task.TaskStatus

TaskStatus of a finished Task

T

Task - Class in org.opensearch.task.commons.task

A Background Task to be run on Offline Node.

Task(TaskId, TaskStatus, TaskParams, TaskType, long, long, long, long, long, WorkerNode) - Constructor for class org.opensearch.task.commons.task.Task

Constructor for Task

Task.Builder - Class in org.opensearch.task.commons.task

Builder class for Task.

TaskId - Class in org.opensearch.task.commons.task

Class encapsulating Task identifier

TaskId(String) - Constructor for class org.opensearch.task.commons.task.TaskId

Constructor to initialize TaskId

TaskListRequest - Class in org.opensearch.task.commons.clients

Request object for listing tasks

TaskListRequest() - Constructor for class org.opensearch.task.commons.clients.TaskListRequest

Default constructor

TaskManagerClient - Interface in org.opensearch.task.commons.clients

Client used to interact with Task Store/Queue.

TaskParams - Class in org.opensearch.task.commons.task

Base class for all TaskParams implementation of various TaskTypes

TaskParams() - Constructor for class org.opensearch.task.commons.task.TaskParams

Default constructor

TaskProducerClient - Interface in org.opensearch.task.commons.clients

Producer interface used to submit new tasks for execution on worker nodes.

taskStatus(TaskStatus) - Method in class org.opensearch.task.commons.task.Task.Builder

Update the Task Status

TaskStatus - Enum in org.opensearch.task.commons.task

Task status enum

taskType(TaskStatus...) - Method in class org.opensearch.task.commons.clients.TaskListRequest

Update task status to filter with in the request

taskType(TaskType...) - Method in class org.opensearch.task.commons.clients.TaskListRequest

Update task types to filter with in the request

TaskType - Enum in org.opensearch.task.commons.task

Enum for task type

TaskWorker - Interface in org.opensearch.task.commons.worker

Task Worker that executes the Task

TaskWorkerClient - Interface in org.opensearch.task.commons.clients

Consumer interface used to find new tasks assigned to a WorkerNode for execution.

U

UNASSIGNED - Enum constant in enum org.opensearch.task.commons.task.TaskStatus

TaskStatus of a Task which is not yet assigned to or picked up by a worker

updateTask(Task) - Method in interface org.opensearch.task.commons.clients.TaskManagerClient

Update task in TaskStore/Queue

V

valueOf(String) - Static method in enum org.opensearch.task.commons.task.TaskStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.opensearch.task.commons.task.TaskType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.opensearch.task.commons.task.TaskStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.opensearch.task.commons.task.TaskType

Returns an array containing the constants of this enum type, in the order they are declared.

W

WorkerNode - Class in org.opensearch.task.commons.worker

Represents a worker node in the fleet

A B C E F G H L M O P S T U V W
All Classes and Interfaces|All Packages