Package org.opensearch.client.opensearch.tasks

Class CancelRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.tasks.CancelRequest

All Implemented Interfaces:

ToCopyableBuilder<CancelRequest.Builder,CancelRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class CancelRequest
extends RequestBase
implements ToCopyableBuilder<CancelRequest.Builder,CancelRequest>

Cancels a task, if it can be cancelled through an API.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<CancelRequest,CancelResponse,ErrorResponse>	_ENDPOINT	Endpoint "tasks.cancel".

Method Summary

Modifier and Type	Method	Description
final List<String>	actions()	A comma-separated list of actions that should be returned.
protected void	applyQueryParameters(Map<String,String> params)
static CancelRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final List<String>	nodes()	A comma-separated list of node IDs or names used to limit the returned information.
static CancelRequest	of(Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)
final String	parentTaskId()	Returns tasks with a specified parent task ID (node_id:task_number).
final String	taskId()	The task ID.
CancelRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Boolean	waitForCompletion()	Waits for the matching task to complete.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<CancelRequest,CancelResponse,ErrorResponse> _ENDPOINT

Endpoint "tasks.cancel".

Method Details

of

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

actions

@Nonnull
public final List<String> actions()

A comma-separated list of actions that should be returned. Keep empty to return all.

API name: actions

nodes

@Nonnull
public final List<String> nodes()

A comma-separated list of node IDs or names used to limit the returned information. Use _local to return information from the node you're connecting to, specify the node name to get information from a specific node, or keep the parameter empty to get information from all nodes.

API name: nodes

parentTaskId

@Nullable
public final String parentTaskId()

Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.

API name: parent_task_id

taskId

@Nullable
public final String taskId()

The task ID.

API name: task_id

waitForCompletion

@Nullable
public final Boolean waitForCompletion()

Waits for the matching task to complete. When true, the request is blocked until the task has completed.

API name: wait_for_completion

toBuilder

@Nonnull
public CancelRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CancelRequest.Builder,CancelRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static CancelRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object