Package org.elasticsearch.client

Class RollupClient

java.lang.Object
org.elasticsearch.client.RollupClient
public class RollupClient
extends java.lang.Object
A wrapper for the RestHighLevelClient that provides methods for accessing the Elastic Rollup-related methods

See the X-Pack Rollup APIs on elastic.co for more information.

  • Method Details

    • putRollupJob

      public AcknowledgedResponse putRollupJob​(PutRollupJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Put a rollup job into the cluster 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

    • putRollupJobAsync

      public org.elasticsearch.client.Cancellable putRollupJobAsync​(PutRollupJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<AcknowledgedResponse> listener)
      Asynchronously put a rollup job into the cluster 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

    • startRollupJob

      public StartRollupJobResponse startRollupJob​(StartRollupJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Start a rollup job 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

    • startRollupJobAsync

      public org.elasticsearch.client.Cancellable startRollupJobAsync​(StartRollupJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<StartRollupJobResponse> listener)
      Asynchronously start a rollup job 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

    • stopRollupJob

      public StopRollupJobResponse stopRollupJob​(StopRollupJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Stop a rollup job 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

    • stopRollupJobAsync

      public org.elasticsearch.client.Cancellable stopRollupJobAsync​(StopRollupJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<StopRollupJobResponse> listener)
      Asynchronously stop a rollup job 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

    • deleteRollupJob

      public AcknowledgedResponse deleteRollupJob​(DeleteRollupJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Delete a rollup job from the cluster 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

    • deleteRollupJobAsync

      public org.elasticsearch.client.Cancellable deleteRollupJobAsync​(DeleteRollupJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<AcknowledgedResponse> listener)
      Asynchronously delete a rollup job from the cluster See The docs for details.
      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

    • getRollupJob

      public GetRollupJobResponse getRollupJob​(GetRollupJobRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Get a rollup job from the cluster. 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

    • getRollupJobAsync

      public org.elasticsearch.client.Cancellable getRollupJobAsync​(GetRollupJobRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetRollupJobResponse> listener)
      Asynchronously get a rollup job from the cluster. 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

    • search

      public org.elasticsearch.action.search.SearchResponse search​(org.elasticsearch.action.search.SearchRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Perform a rollup search. 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​(org.elasticsearch.action.search.SearchRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.SearchResponse> listener)
      Perform a rollup search. 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

    • getRollupCapabilities

      public GetRollupCapsResponse getRollupCapabilities​(GetRollupCapsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Get the Rollup Capabilities of a target (non-rollup) index or pattern 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

    • getRollupCapabilitiesAsync

      public org.elasticsearch.client.Cancellable getRollupCapabilitiesAsync​(GetRollupCapsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetRollupCapsResponse> listener)
      Asynchronously Get the Rollup Capabilities of a target (non-rollup) index or pattern 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

    • getRollupIndexCapabilities

      public GetRollupIndexCapsResponse getRollupIndexCapabilities​(GetRollupIndexCapsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Get the Rollup Index Capabilities of a rollup index or pattern 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

    • getRollupIndexCapabilitiesAsync

      public org.elasticsearch.client.Cancellable getRollupIndexCapabilitiesAsync​(GetRollupIndexCapsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetRollupIndexCapsResponse> listener)
      Asynchronously Get the Rollup Index Capabilities of a rollup index or pattern 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