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

Class TasksClient

java.lang.Object

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

org.opensearch.client.opensearch.api.tasks.TasksClient

public class TasksClient
extends ApiClient<TasksClient>

Client for the tasks namespace.

Field Summary

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

requestOptions, transport

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CancelResponse	cancel(java.util.function.Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)	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.
GetResponse	get(java.util.function.Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn)	Returns information about a task.
GetResponse	get(GetRequest request)	Returns information about a task.
ListResponse	list(java.util.function.Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)	Returns a list of tasks.
ListResponse	list(ListRequest request)	Returns a list of tasks.
TasksClient	withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)	Creates a new TasksClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.
TasksClient	withRequestOptions(org.opensearch.client.RequestOptions options)	Creates a new TasksClient(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

TasksClient

public TasksClient(Transport transport)

TasksClient

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

Method Details

cancel

public 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 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 GetResponse get(GetRequest request) throws java.io.IOException

Returns information about a task.

Throws:

java.io.IOException

get

public final 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 ListResponse list(ListRequest request) throws java.io.IOException

Returns a list of tasks.

Throws:

java.io.IOException

list

public final 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 TasksClient withRequestOptions(@Nullable org.opensearch.client.RequestOptions options)

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

Specified by:

withRequestOptions in class ApiClient<TasksClient>

withRequestOptions

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

Creates a new TasksClient(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.