Package org.opensearch.client.opensearch.tasks

Class OpenSearchTasksAsyncClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchTasksAsyncClient>

org.opensearch.client.opensearch.tasks.OpenSearchTasksAsyncClient

public class OpenSearchTasksAsyncClient
extends ApiClient<OpenSearchTransport,OpenSearchTasksAsyncClient>

Client for the tasks namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchTasksAsyncClient(OpenSearchTransport transport)
OpenSearchTasksAsyncClient(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<CancelResponse>	cancel()	Cancels a task, if it can be cancelled through an API.
java.util.concurrent.CompletableFuture<CancelResponse>	cancel(java.util.function.Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)	Cancels a task, if it can be cancelled through an API.
java.util.concurrent.CompletableFuture<CancelResponse>	cancel(CancelRequest request)	Cancels a task, if it can be cancelled through an API.
java.util.concurrent.CompletableFuture<GetTasksResponse>	get(java.util.function.Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn)	Returns information about a task.
java.util.concurrent.CompletableFuture<GetTasksResponse>	get(GetTasksRequest request)	Returns information about a task.
java.util.concurrent.CompletableFuture<ListResponse>	list()	Returns a list of tasks.
java.util.concurrent.CompletableFuture<ListResponse>	list(java.util.function.Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)	Returns a list of tasks.
java.util.concurrent.CompletableFuture<ListResponse>	list(ListRequest request)	Returns a list of tasks.
OpenSearchTasksAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenSearchTasksAsyncClient

public OpenSearchTasksAsyncClient(OpenSearchTransport transport)

OpenSearchTasksAsyncClient

public OpenSearchTasksAsyncClient(OpenSearchTransport transport,
                                  @Nullable
                                  TransportOptions transportOptions)

Method Detail

withTransportOptions

public OpenSearchTasksAsyncClient withTransportOptions(@Nullable
                                                       TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchTasksAsyncClient>

cancel

public java.util.concurrent.CompletableFuture<CancelResponse> cancel(CancelRequest request)
                                                              throws java.io.IOException,
                                                                     OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

cancel

public final java.util.concurrent.CompletableFuture<CancelResponse> cancel(java.util.function.Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)
                                                                    throws java.io.IOException,
                                                                           OpenSearchException

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

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

cancel

public java.util.concurrent.CompletableFuture<CancelResponse> cancel()
                                                              throws java.io.IOException,
                                                                     OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

get

public java.util.concurrent.CompletableFuture<GetTasksResponse> get(GetTasksRequest request)
                                                             throws java.io.IOException,
                                                                    OpenSearchException

Returns information about a task.

Throws:

java.io.IOException

OpenSearchException

get

public final java.util.concurrent.CompletableFuture<GetTasksResponse> get(java.util.function.Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn)
                                                                   throws java.io.IOException,
                                                                          OpenSearchException

Returns information about a task.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

list

public java.util.concurrent.CompletableFuture<ListResponse> list(ListRequest request)
                                                          throws java.io.IOException,
                                                                 OpenSearchException

Returns a list of tasks.

Throws:

java.io.IOException

OpenSearchException

list

public final java.util.concurrent.CompletableFuture<ListResponse> list(java.util.function.Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)
                                                                throws java.io.IOException,
                                                                       OpenSearchException

Returns a list of tasks.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

list

public java.util.concurrent.CompletableFuture<ListResponse> list()
                                                          throws java.io.IOException,
                                                                 OpenSearchException

Returns a list of tasks.

Throws:

java.io.IOException

OpenSearchException