Package co.elastic.clients.elasticsearch.tasks

Class GetTasksRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.tasks.GetTasksRequest

public class GetTasksRequest
extends RequestBase

Get task information. Get information about a task currently running in the cluster.

WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

If the task identifier is not found, a 404 response code indicates that there are no resources that match the request.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetTasksRequest.Builder	Builder for GetTasksRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetTasksRequest,GetTasksResponse,ErrorResponse>	_ENDPOINT	Endpoint "tasks.get".

Method Summary

Modifier and Type	Method	Description
static GetTasksRequest	of(Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn)
final String	taskId()	Required - The task identifier.
final Time	timeout()	The period to wait for a response.
final Boolean	waitForCompletion()	If true, the request blocks until the task has completed.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<GetTasksRequest,GetTasksResponse,ErrorResponse> _ENDPOINT

Endpoint "tasks.get".

Method Details

of

public static GetTasksRequest of(Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn)

taskId

public final String taskId()

Required - The task identifier.

API name: task_id

timeout

@Nullable
public final Time timeout()

The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

waitForCompletion

@Nullable
public final Boolean waitForCompletion()

If true, the request blocks until the task has completed.

API name: wait_for_completion