Class ElasticsearchTasksClient
java.lang.Object
co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchTasksClient>
co.elastic.clients.elasticsearch.tasks.ElasticsearchTasksClient
public class ElasticsearchTasksClient extends ApiClient<ElasticsearchTransport,ElasticsearchTasksClient>
Client for the tasks namespace.
-
Field Summary
Fields inherited from class co.elastic.clients.ApiClient
transport, transportOptions
-
Constructor Summary
Constructors Constructor Description ElasticsearchTasksClient(ElasticsearchTransport transport)
ElasticsearchTasksClient(ElasticsearchTransport 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(CancelRequest request)
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.GetTasksResponse
get(GetTasksRequest request)
Returns information about a task.GetTasksResponse
get(java.util.function.Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn)
Returns information about a task.ListResponse
list()
Returns a list of tasks.ListResponse
list(ListRequest request)
Returns a list of tasks.ListResponse
list(java.util.function.Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)
Returns a list of tasks.ElasticsearchTasksClient
withTransportOptions(TransportOptions transportOptions)
Creates a new client with some request optionsMethods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
ElasticsearchTasksClient
-
ElasticsearchTasksClient
public ElasticsearchTasksClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
withTransportOptions
Description copied from class:ApiClient
Creates a new client with some request options- Specified by:
withTransportOptions
in classApiClient<ElasticsearchTransport,ElasticsearchTasksClient>
-
cancel
public CancelResponse cancel(CancelRequest request) throws java.io.IOException, ElasticsearchExceptionCancels a task, if it can be cancelled through an API.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
cancel
public final CancelResponse cancel(java.util.function.Function<CancelRequest.Builder,ObjectBuilder<CancelRequest>> fn) throws java.io.IOException, ElasticsearchExceptionCancels a task, if it can be cancelled through an API.- Parameters:
fn
- a function that initializes a builder to create theCancelRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
cancel
Cancels a task, if it can be cancelled through an API.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
get
public GetTasksResponse get(GetTasksRequest request) throws java.io.IOException, ElasticsearchExceptionReturns information about a task.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
get
public final GetTasksResponse get(java.util.function.Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns information about a task.- Parameters:
fn
- a function that initializes a builder to create theGetTasksRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
list
Returns a list of tasks.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
list
public final ListResponse list(java.util.function.Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns a list of tasks.- Parameters:
fn
- a function that initializes a builder to create theListRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
list
Returns a list of tasks.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-