GetTasksRequest (java-client 7.15.2 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.tasks.GetTasksRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class GetTasksRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class GetTasksRequest.Builder
Builder for GetTasksRequest.

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

Constructor Summary

Constructors
Constructor	Description
`GetTasksRequest(GetTasksRequest.Builder builder)`
`GetTasksRequest(java.util.function.Function<GetTasksRequest.Builder,GetTasksRequest.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<GetTasksRequest,GetTasksResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "tasks.get".
Constructor Details
- GetTasksRequest
  
  public GetTasksRequest(GetTasksRequest.Builder builder)
- GetTasksRequest
  
  public GetTasksRequest(java.util.function.Function<GetTasksRequest.Builder,GetTasksRequest.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