Package org.opensearch.client.opensearch.tasks

Class OpenSearchTasksClient

java.lang.Object

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

org.opensearch.client.opensearch.tasks.OpenSearchTasksClient

public class OpenSearchTasksClient
extends ApiClient<OpenSearchTransport,OpenSearchTasksClient>

Client for the tasks namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchTasksClient(OpenSearchTransport transport)
OpenSearchTasksClient(OpenSearchTransport 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(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.
GetTasksResponse	get(java.util.function.Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn)	Returns information about a task.
GetTasksResponse	get(GetTasksRequest request)	Returns information about a task.
ListResponse	list()	Returns a list of tasks.
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.
OpenSearchTasksClient	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

OpenSearchTasksClient

public OpenSearchTasksClient(OpenSearchTransport transport)

OpenSearchTasksClient

public OpenSearchTasksClient(OpenSearchTransport transport,
                             @Nullable
                             TransportOptions transportOptions)

Method Detail

withTransportOptions

public OpenSearchTasksClient withTransportOptions(@Nullable
                                                  TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchTasksClient>

cancel

public 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 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 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 GetTasksResponse get(GetTasksRequest request)
                     throws java.io.IOException,
                            OpenSearchException

Returns information about a task.

Throws:

java.io.IOException

OpenSearchException

get

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

Returns a list of tasks.

Throws:

java.io.IOException

OpenSearchException

list

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

Returns a list of tasks.

Throws:

java.io.IOException

OpenSearchException