Package co.elastic.clients.elasticsearch.tasks

Class ElasticsearchTasksClient

java.lang.Object

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

co.elastic.clients.elasticsearch.tasks.ElasticsearchTasksClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchTasksClient
extends ApiClient<ElasticsearchTransport,ElasticsearchTasksClient>

Client for the tasks namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchTasksClient

public ElasticsearchTasksClient(ElasticsearchTransport transport)

ElasticsearchTasksClient

public ElasticsearchTasksClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchTasksClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchTasksClient>

cancel

public CancelResponse cancel(CancelRequest request)
                      throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

cancel

public final CancelResponse cancel(Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)
                            throws IOException,
ElasticsearchException

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

cancel

public CancelResponse cancel()
                      throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public GetTasksResponse get(GetTasksRequest request)
                     throws IOException,
ElasticsearchException

Get task information. Returns information about the tasks currently executing in the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public final GetTasksResponse get(Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn)
                           throws IOException,
ElasticsearchException

Get task information. Returns information about the tasks currently executing in the cluster.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

list

public ListResponse list(ListRequest request)
                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

list

public final ListResponse list(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

list

public ListResponse list()
                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co