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 a reindex task.

Get the status and progress of a specific reindex task.

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