Package org.opensearch.client.opensearch.tasks

Class GetTasksRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.tasks.GetTasksRequest

All Implemented Interfaces:

ToCopyableBuilder<GetTasksRequest.Builder,GetTasksRequest>

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

Returns information about a task.

Nested Class Summary

Nested Classes

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

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<GetTasksRequest,GetTasksResponse,ErrorResponse>	_ENDPOINT	Endpoint "tasks.get".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static GetTasksRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static GetTasksRequest	of(Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn)
final String	taskId()	Required - The task ID.
final Time	timeout()	The amount of time to wait for a response.
GetTasksRequest.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<GetTasksRequest,GetTasksResponse,ErrorResponse> _ENDPOINT

Endpoint "tasks.get".

Method Details

of

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

taskId

@Nonnull
public final String taskId()

Required - The task ID.

API name: task_id

timeout

@Nullable
public final Time timeout()

The amount of time to wait for a response.

API name: timeout

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 GetTasksRequest.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<GetTasksRequest.Builder,GetTasksRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static GetTasksRequest.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