Package co.elastic.clients.elasticsearch.tasks

Class GetRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.tasks.GetRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class GetRequest
extends RequestBase

Nested Class Summary

Nested Classes

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

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 Endpoint<GetRequest,GetResponse,ElasticsearchError>	ENDPOINT	Endpoint "tasks.get".

Constructor Summary

Constructors

Constructor	Description
GetRequest(GetRequest.Builder builder)
GetRequest(java.util.function.Function<GetRequest.Builder,GetRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.String	taskId()	Required - Return the task with specified id (node_id:task_number)
java.lang.String	timeout()	Explicit operation timeout
java.lang.Boolean	waitForCompletion()	Wait for the matching tasks to complete (default: false)

Methods inherited from class java.lang.Object

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

Field Details

ENDPOINT

public static final Endpoint<GetRequest,GetResponse,ElasticsearchError> ENDPOINT

Endpoint "tasks.get".

Constructor Details

GetRequest

public GetRequest(GetRequest.Builder builder)

GetRequest

public GetRequest(java.util.function.Function<GetRequest.Builder,GetRequest.Builder> fn)

Method Details

taskId

public java.lang.String taskId()

Required - Return the task with specified id (node_id:task_number)

API name: task_id

timeout

@Nullable
public java.lang.String timeout()

Explicit operation timeout

API name: timeout

waitForCompletion

@Nullable
public java.lang.Boolean waitForCompletion()

Wait for the matching tasks to complete (default: false)

API name: wait_for_completion