Package org.elasticsearch.client

Class CcrClient

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

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

  • Method Details

    • putFollow

      public PutFollowResponse putFollow​(PutFollowRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Executes the put follow api, which creates a follower index and then the follower index starts following the leader index. 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

    • putFollowAsync

      public org.elasticsearch.client.Cancellable putFollowAsync​(PutFollowRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PutFollowResponse> listener)
      Asynchronously executes the put follow api, which creates a follower index and then the follower index starts following the leader index. 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

    • pauseFollow

      public AcknowledgedResponse pauseFollow​(PauseFollowRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Instructs a follower index to pause the following of a leader index. 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

    • pauseFollowAsync

      public org.elasticsearch.client.Cancellable pauseFollowAsync​(PauseFollowRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<AcknowledgedResponse> listener)
      Asynchronously instruct a follower index to pause the following of a leader index. 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

    • resumeFollow

      public AcknowledgedResponse resumeFollow​(ResumeFollowRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Instructs a follower index to resume the following of a leader index. 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

    • resumeFollowAsync

      public org.elasticsearch.client.Cancellable resumeFollowAsync​(ResumeFollowRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<AcknowledgedResponse> listener)
      Asynchronously instruct a follower index to resume the following of a leader index. 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

    • unfollow

      public AcknowledgedResponse unfollow​(UnfollowRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Instructs a follower index to unfollow and become a regular index. Note that index following needs to be paused and the follower index needs to be closed. 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

    • unfollowAsync

      public org.elasticsearch.client.Cancellable unfollowAsync​(UnfollowRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<AcknowledgedResponse> listener)
      Asynchronously instructs a follower index to unfollow and become a regular index. Note that index following needs to be paused and the follower index needs to be closed. 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

    • forgetFollower

      public BroadcastResponse forgetFollower​(ForgetFollowerRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Instructs an index acting as a leader index to forget the specified follower index. See the docs for more details on the intended usage of this API.
      Parameters:
      request - the request
      options - the request options (e.g., headers), use RequestOptions.DEFAULT if the defaults are acceptable.
      Returns:
      the response
      Throws:
      java.io.IOException - if an I/O exception occurs while executing this request

    • forgetFollowerAsync

      public org.elasticsearch.client.Cancellable forgetFollowerAsync​(ForgetFollowerRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<BroadcastResponse> listener)
      Asynchronously instructs an index acting as a leader index to forget the specified follower index. See the docs for more details on the intended usage of this API.
      Parameters:
      request - the request
      options - the request options (e.g., headers), use RequestOptions.DEFAULT if the defaults are acceptable.
      Returns:
      cancellable that may be used to cancel the request

    • putAutoFollowPattern

      public AcknowledgedResponse putAutoFollowPattern​(PutAutoFollowPatternRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Stores an auto follow 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

    • putAutoFollowPatternAsync

      public org.elasticsearch.client.Cancellable putAutoFollowPatternAsync​(PutAutoFollowPatternRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<AcknowledgedResponse> listener)
      Asynchronously stores an auto follow 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

    • deleteAutoFollowPattern

      public AcknowledgedResponse deleteAutoFollowPattern​(DeleteAutoFollowPatternRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Deletes an auto follow 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

    • deleteAutoFollowPatternAsync

      public org.elasticsearch.client.Cancellable deleteAutoFollowPatternAsync​(DeleteAutoFollowPatternRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<AcknowledgedResponse> listener)
      Asynchronously deletes an auto follow 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

    • getAutoFollowPattern

      public GetAutoFollowPatternResponse getAutoFollowPattern​(GetAutoFollowPatternRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Gets an auto follow 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

    • getAutoFollowPatternAsync

      public org.elasticsearch.client.Cancellable getAutoFollowPatternAsync​(GetAutoFollowPatternRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetAutoFollowPatternResponse> listener)
      Asynchronously gets an auto follow 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

    • pauseAutoFollowPattern

      public AcknowledgedResponse pauseAutoFollowPattern​(PauseAutoFollowPatternRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Pauses an auto follow 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

    • pauseAutoFollowPatternAsync

      public org.elasticsearch.client.Cancellable pauseAutoFollowPatternAsync​(PauseAutoFollowPatternRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<AcknowledgedResponse> listener)
      Asynchronously pauses an auto follow 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

    • resumeAutoFollowPattern

      public AcknowledgedResponse resumeAutoFollowPattern​(ResumeAutoFollowPatternRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Resumes an auto follow 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

    • resumeAutoFollowPatternAsync

      public org.elasticsearch.client.Cancellable resumeAutoFollowPatternAsync​(ResumeAutoFollowPatternRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<AcknowledgedResponse> listener)
      Asynchronously resumes an auto follow 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

    • getCcrStats

      public CcrStatsResponse getCcrStats​(CcrStatsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Gets all CCR 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

    • getCcrStatsAsync

      public org.elasticsearch.client.Cancellable getCcrStatsAsync​(CcrStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<CcrStatsResponse> listener)
      Asynchronously gets all CCR 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:
      cancellable that may be used to cancel the request

    • getFollowStats

      public FollowStatsResponse getFollowStats​(FollowStatsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Gets follow stats for specific indices. 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

    • getFollowStatsAsync

      public org.elasticsearch.client.Cancellable getFollowStatsAsync​(FollowStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<FollowStatsResponse> listener)
      Asynchronously gets follow stats for specific indices. 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:
      cancellable that may be used to cancel the request

    • getFollowInfo

      public FollowInfoResponse getFollowInfo​(FollowInfoRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Gets follow info for specific indices. 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

    • getFollowInfoAsync

      public org.elasticsearch.client.Cancellable getFollowInfoAsync​(FollowInfoRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<FollowInfoResponse> listener)
      Asynchronously gets follow info for specific indices. 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:
      cancellable that may be used to cancel the request