Package co.elastic.clients.elasticsearch.core

Class GetReindexRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.GetReindexRequest

public class GetReindexRequest
extends RequestBase

Get the status and progress of a specific reindex task.

This API follows reindex tasks across node-shutdown relocations, so callers can keep using the original task ID throughout the lifetime of the operation. Returned task IDs and timings reflect the original task, not its relocated successor. Relocated task IDs are also supported. They are followed transparently and return the task ID and timings of the original task.

When the task ID cannot be resolved, the API returns the response below with a 404 status code. This response is used whether the ID is unknown, refers to a non-reindex task, refers to a sliced child subtask, or refers to a task whose node left the cluster with no stored result (e.g. a non-graceful shutdown).

 {
   "error": {
     "type": "resource_not_found_exception",
     "reason": "Reindex operation [r1A2WoRbTwKZ516z6NEs5A:36619] not found"
   },
   "status": 404
 }
 
 

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<GetReindexRequest,GetReindexResponse,ErrorResponse>	_ENDPOINT	Endpoint "get_reindex".

Method Summary

Modifier and Type	Method	Description
static GetReindexRequest	of(Function<GetReindexRequest.Builder,ObjectBuilder<GetReindexRequest>> fn)
GetReindexRequest.Builder	rebuild()
final String	taskId()	Required - The ID of the reindex task to retrieve.
final Time	timeout()	The period to wait for the reindex task to complete when wait_for_completion is true.
final Boolean	waitForCompletion()	If true, the request blocks until the reindex task completes, then returns the result.

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<GetReindexRequest,GetReindexResponse,ErrorResponse> _ENDPOINT

Endpoint "get_reindex".

Method Details

of

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

taskId

public final String taskId()

Required - The ID of the reindex task to retrieve.

API name: task_id

timeout

@Nullable
public final Time timeout()

The period to wait for the reindex task to complete when wait_for_completion is true.

API name: timeout

waitForCompletion

@Nullable
public final Boolean waitForCompletion()

If true, the request blocks until the reindex task completes, then returns the result.

API name: wait_for_completion

rebuild

public GetReindexRequest.Builder rebuild()

Returns:

New GetReindexRequest.Builder initialized with field values of this instance