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 Summary

Modifier and Type	Method	Description
`AcknowledgedResponse`	`deleteAutoFollowPattern(DeleteAutoFollowPatternRequest request, RequestOptions options)`	Deletes an auto follow pattern.
`Cancellable`	`deleteAutoFollowPatternAsync(DeleteAutoFollowPatternRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)`	Asynchronously deletes an auto follow pattern.
`BroadcastResponse`	`forgetFollower(ForgetFollowerRequest request, RequestOptions options)`	Instructs an index acting as a leader index to forget the specified follower index.
`Cancellable`	`forgetFollowerAsync(ForgetFollowerRequest request, RequestOptions options, ActionListener<BroadcastResponse> listener)`	Asynchronously instructs an index acting as a leader index to forget the specified follower index.
`GetAutoFollowPatternResponse`	`getAutoFollowPattern(GetAutoFollowPatternRequest request, RequestOptions options)`	Gets an auto follow pattern.
`Cancellable`	`getAutoFollowPatternAsync(GetAutoFollowPatternRequest request, RequestOptions options, ActionListener<GetAutoFollowPatternResponse> listener)`	Asynchronously gets an auto follow pattern.
`CcrStatsResponse`	`getCcrStats(CcrStatsRequest request, RequestOptions options)`	Gets all CCR stats.
`Cancellable`	`getCcrStatsAsync(CcrStatsRequest request, RequestOptions options, ActionListener<CcrStatsResponse> listener)`	Asynchronously gets all CCR stats.
`FollowInfoResponse`	`getFollowInfo(FollowInfoRequest request, RequestOptions options)`	Gets follow info for specific indices.
`Cancellable`	`getFollowInfoAsync(FollowInfoRequest request, RequestOptions options, ActionListener<FollowInfoResponse> listener)`	Asynchronously gets follow info for specific indices.
`FollowStatsResponse`	`getFollowStats(FollowStatsRequest request, RequestOptions options)`	Gets follow stats for specific indices.
`Cancellable`	`getFollowStatsAsync(FollowStatsRequest request, RequestOptions options, ActionListener<FollowStatsResponse> listener)`	Asynchronously gets follow stats for specific indices.
`AcknowledgedResponse`	`pauseAutoFollowPattern(PauseAutoFollowPatternRequest request, RequestOptions options)`	Pauses an auto follow pattern.
`Cancellable`	`pauseAutoFollowPatternAsync(PauseAutoFollowPatternRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)`	Asynchronously pauses an auto follow pattern.
`AcknowledgedResponse`	`pauseFollow(PauseFollowRequest request, RequestOptions options)`	Instructs a follower index to pause the following of a leader index.
`Cancellable`	`pauseFollowAsync(PauseFollowRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)`	Asynchronously instruct a follower index to pause the following of a leader index.
`AcknowledgedResponse`	`putAutoFollowPattern(PutAutoFollowPatternRequest request, RequestOptions options)`	Stores an auto follow pattern.
`Cancellable`	`putAutoFollowPatternAsync(PutAutoFollowPatternRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)`	Asynchronously stores an auto follow pattern.
`PutFollowResponse`	`putFollow(PutFollowRequest request, RequestOptions options)`	Executes the put follow api, which creates a follower index and then the follower index starts following the leader index.
`Cancellable`	`putFollowAsync(PutFollowRequest request, RequestOptions options, ActionListener<PutFollowResponse> listener)`	Asynchronously executes the put follow api, which creates a follower index and then the follower index starts following the leader index.
`AcknowledgedResponse`	`resumeAutoFollowPattern(ResumeAutoFollowPatternRequest request, RequestOptions options)`	Resumes an auto follow pattern.
`Cancellable`	`resumeAutoFollowPatternAsync(ResumeAutoFollowPatternRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)`	Asynchronously resumes an auto follow pattern.
`AcknowledgedResponse`	`resumeFollow(ResumeFollowRequest request, RequestOptions options)`	Instructs a follower index to resume the following of a leader index.
`Cancellable`	`resumeFollowAsync(ResumeFollowRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)`	Asynchronously instruct a follower index to resume the following of a leader index.
`AcknowledgedResponse`	`unfollow(UnfollowRequest request, RequestOptions options)`	Instructs a follower index to unfollow and become a regular index.
`Cancellable`	`unfollowAsync(UnfollowRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)`	Asynchronously instructs a follower index to unfollow and become a regular index.

Methods inherited from class java.lang.Object

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

Method Details
- putFollow
  
  public PutFollowResponse putFollow(PutFollowRequest request, 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 Cancellable putFollowAsync(PutFollowRequest request, RequestOptions options, 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, 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 Cancellable pauseFollowAsync(PauseFollowRequest request, RequestOptions options, 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, 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 Cancellable resumeFollowAsync(ResumeFollowRequest request, RequestOptions options, 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, 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 Cancellable unfollowAsync(UnfollowRequest request, RequestOptions options, 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, 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 Cancellable forgetFollowerAsync(ForgetFollowerRequest request, RequestOptions options, 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, 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 Cancellable putAutoFollowPatternAsync(PutAutoFollowPatternRequest request, RequestOptions options, 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, 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 Cancellable deleteAutoFollowPatternAsync(DeleteAutoFollowPatternRequest request, RequestOptions options, 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, 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 Cancellable getAutoFollowPatternAsync(GetAutoFollowPatternRequest request, RequestOptions options, 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, 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 Cancellable pauseAutoFollowPatternAsync(PauseAutoFollowPatternRequest request, RequestOptions options, 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, 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 Cancellable resumeAutoFollowPatternAsync(ResumeAutoFollowPatternRequest request, RequestOptions options, 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, 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 Cancellable getCcrStatsAsync(CcrStatsRequest request, RequestOptions options, 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, 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 Cancellable getFollowStatsAsync(FollowStatsRequest request, RequestOptions options, 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, 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 Cancellable getFollowInfoAsync(FollowInfoRequest request, RequestOptions options, 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

Class CcrClient

Method Summary

Methods inherited from class java.lang.Object

Method Details