Package org.opensearch.client.opensearch.api.tasks

Class TasksAsyncClient

java.lang.Object

org.opensearch.client.base.ApiClient<TasksAsyncClient>

org.opensearch.client.opensearch.api.tasks.TasksAsyncClient

public class TasksAsyncClient
extends ApiClient<TasksAsyncClient>

Client for the tasks namespace.

Field Summary

Fields inherited from class org.opensearch.client.base.ApiClient

requestOptions, transport

Constructor Summary

Constructors

Constructor	Description
TasksAsyncClient(Transport transport)
TasksAsyncClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Summary

Modifier and Type	Method	Description
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<GetResponse>	get(java.util.function.Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn)	Returns information about a task.
java.util.concurrent.CompletableFuture<GetResponse>	get(GetRequest request)	Returns information about a task.
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.
TasksAsyncClient	withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)	Creates a new TasksAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.
TasksAsyncClient	withRequestOptions(org.opensearch.client.RequestOptions options)	Creates a new TasksAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Methods inherited from class org.opensearch.client.base.ApiClient

getDeserializer, requestOptions

Methods inherited from class java.lang.Object

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

Constructor Details

TasksAsyncClient

public TasksAsyncClient(Transport transport)

TasksAsyncClient

public TasksAsyncClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Details

cancel

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

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

Throws:

java.io.IOException

cancel

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

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

get

public java.util.concurrent.CompletableFuture<GetResponse> get(GetRequest request) throws java.io.IOException

Returns information about a task.

Throws:

java.io.IOException

get

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

Returns information about a task.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

list

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

Returns a list of tasks.

Throws:

java.io.IOException

list

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

Returns a list of tasks.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

withRequestOptions

public TasksAsyncClient withRequestOptions(@Nullable org.opensearch.client.RequestOptions options)

Creates a new TasksAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Specified by:

withRequestOptions in class ApiClient<TasksAsyncClient>

withRequestOptions

public TasksAsyncClient withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)

Creates a new TasksAsyncClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.

Parameters:

fn - a function taking an options builder initialized with the current request options, or initialized with default values.