Package org.elasticsearch.client

Class EqlClient

java.lang.Object
org.elasticsearch.client.EqlClient
public final class EqlClient
extends java.lang.Object
A wrapper for the RestHighLevelClient that provides methods for accessing the Elastic EQL related functions

See the EQL APIs on elastic.co for more information.

  • Method Summary

    Modifier and Type Method Description
    EqlSearchResponse search​(EqlSearchRequest request, org.elasticsearch.client.RequestOptions options)
    Executes the eql search query.
    org.elasticsearch.client.Cancellable searchAsync​(EqlSearchRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<EqlSearchResponse> listener)
    Asynchronously executes the eql search query.
    EqlStatsResponse stats​(EqlStatsRequest request, org.elasticsearch.client.RequestOptions options)
    Get the eql stats See the docs for more.
    org.elasticsearch.client.Cancellable statsAsync​(EqlStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<EqlStatsResponse> listener)
    Asynchronously get the eql stats See the docs for more.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • search

      public EqlSearchResponse search​(EqlSearchRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Executes the eql search query.

      See the docs for more.

      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      java.io.IOException - in case there is a problem sending the request or parsing back the response

    • searchAsync

      public org.elasticsearch.client.Cancellable searchAsync​(EqlSearchRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<EqlSearchResponse> listener)
      Asynchronously executes the eql search query.

      See the docs for more.

      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • stats

      public EqlStatsResponse stats​(EqlStatsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Get the eql stats See the docs for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      java.io.IOException - in case there is a problem sending the request or parsing back the response

    • statsAsync

      public org.elasticsearch.client.Cancellable statsAsync​(EqlStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<EqlStatsResponse> listener)
      Asynchronously get the eql stats See the docs for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request