Package org.opensearch.client.opensearch.tasks

Class OpenSearchTasksClient

java.lang.Object

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

org.opensearch.client.opensearch.tasks.OpenSearchTasksClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
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
final CancelResponse	cancel()	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.
CancelResponse	cancel(CancelRequest request)	Cancels a task, if it can be cancelled through an API.
final GetTasksResponse	get(Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn)	Returns information about a task.
GetTasksResponse	get(GetTasksRequest request)	Returns information about a task.
final ListResponse	list()	Returns a list of tasks.
final ListResponse	list(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 Details

OpenSearchTasksClient

public OpenSearchTasksClient(OpenSearchTransport transport)

OpenSearchTasksClient

public OpenSearchTasksClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

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 IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

cancel

public final CancelResponse cancel(Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn)
                            throws 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:

IOException

OpenSearchException

cancel

public final CancelResponse cancel()
                            throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

get

public GetTasksResponse get(GetTasksRequest request)
                     throws IOException,
OpenSearchException

Returns information about a task.

Throws:

IOException

OpenSearchException

get

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

Returns information about a task.

Parameters:

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

Throws:

IOException

OpenSearchException

list

public ListResponse list(ListRequest request)
                  throws IOException,
OpenSearchException

Returns a list of tasks.

Throws:

IOException

OpenSearchException

list

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

Returns a list of tasks.

Parameters:

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

Throws:

IOException

OpenSearchException

list

public final ListResponse list()
                        throws IOException,
OpenSearchException

Returns a list of tasks.

Throws:

IOException

OpenSearchException