Package co.elastic.clients.elasticsearch.core

Class CancelReindexRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.CancelReindexRequest

public class CancelReindexRequest
extends RequestBase

Cancel a reindex task.

Cancel an ongoing reindex task. If wait_for_completion is true (the default), the response contains the final task state after cancellation. If wait_for_completion is false, the response contains only acknowledged: true.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<CancelReindexRequest,CancelReindexResponse,ErrorResponse>	_ENDPOINT	Endpoint "cancel_reindex".

Method Summary

Modifier and Type	Method	Description
static CancelReindexRequest	of(Function<CancelReindexRequest.Builder,ObjectBuilder<CancelReindexRequest>> fn)
CancelReindexRequest.Builder	rebuild()
final String	taskId()	Required - The ID of the reindex task to cancel.
final Boolean	waitForCompletion()	If true (the default), the request blocks until the cancellation is complete and returns the final task state.

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<CancelReindexRequest,CancelReindexResponse,ErrorResponse> _ENDPOINT

Endpoint "cancel_reindex".

Method Details

of

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

taskId

public final String taskId()

Required - The ID of the reindex task to cancel.

API name: task_id

waitForCompletion

@Nullable
public final Boolean waitForCompletion()

If true (the default), the request blocks until the cancellation is complete and returns the final task state. If false, the request returns immediately with acknowledged: true.

API name: wait_for_completion

rebuild

public CancelReindexRequest.Builder rebuild()

Returns:

New CancelReindexRequest.Builder initialized with field values of this instance