Package co.elastic.clients.elasticsearch.tasks

Class ElasticsearchTasksAsyncClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchTasksAsyncClient>

co.elastic.clients.elasticsearch.tasks.ElasticsearchTasksAsyncClient

public class ElasticsearchTasksAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchTasksAsyncClient>

Client for the tasks namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchTasksAsyncClient(ElasticsearchTransport transport)
ElasticsearchTasksAsyncClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<CancelResponse>	cancel()	Cancels a task, if it can be cancelled through an API.
CompletableFuture<CancelResponse>	cancel(CancelRequest request)	Cancels a task, if it can be cancelled through an API.
final CompletableFuture<CancelResponse>	cancel(Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)	Cancels a task, if it can be cancelled through an API.
CompletableFuture<GetTasksResponse>	get(GetTasksRequest request)	Returns information about a task.
final CompletableFuture<GetTasksResponse>	get(Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn)	Returns information about a task.
CompletableFuture<ListResponse>	list()	The task management API returns information about tasks currently executing on one or more nodes in the cluster.
CompletableFuture<ListResponse>	list(ListRequest request)	The task management API returns information about tasks currently executing on one or more nodes in the cluster.
final CompletableFuture<ListResponse>	list(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)	The task management API returns information about tasks currently executing on one or more nodes in the cluster.
ElasticsearchTasksAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchTasksAsyncClient

public ElasticsearchTasksAsyncClient(ElasticsearchTransport transport)

ElasticsearchTasksAsyncClient

public ElasticsearchTasksAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchTasksAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchTasksAsyncClient>

cancel

public CompletableFuture<CancelResponse> cancel(CancelRequest request)

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

See Also:

• Documentation on elastic.co

cancel

public final CompletableFuture<CancelResponse> cancel(Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)

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

Parameters:

fn - a function that initializes a builder to create the CancelRequest

See Also:

• Documentation on elastic.co

cancel

public CompletableFuture<CancelResponse> cancel()

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

See Also:

• Documentation on elastic.co

get

public CompletableFuture<GetTasksResponse> get(GetTasksRequest request)

Returns information about a task.

See Also:

• Documentation on elastic.co

get

public final CompletableFuture<GetTasksResponse> get(Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn)

Returns information about a task.

Parameters:

fn - a function that initializes a builder to create the GetTasksRequest

See Also:

• Documentation on elastic.co

list

public CompletableFuture<ListResponse> list(ListRequest request)

The task management API returns information about tasks currently executing on one or more nodes in the cluster.

See Also:

• Documentation on elastic.co

list

public final CompletableFuture<ListResponse> list(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)

The task management API returns information about tasks currently executing on one or more nodes in the cluster.

Parameters:

fn - a function that initializes a builder to create the ListRequest

See Also:

• Documentation on elastic.co

list

public CompletableFuture<ListResponse> list()

The task management API returns information about tasks currently executing on one or more nodes in the cluster.

See Also:

• Documentation on elastic.co