Package org.elasticsearch.client
Class CcrClient
java.lang.Object
org.elasticsearch.client.CcrClient
Deprecated.
The High Level Rest Client is deprecated in favor of the
Elasticsearch Java API Client
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 TypeMethodDescriptiondeleteAutoFollowPattern
(DeleteAutoFollowPatternRequest request, RequestOptions options) Deprecated.Deletes an auto follow pattern.deleteAutoFollowPatternAsync
(DeleteAutoFollowPatternRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) Deprecated.Asynchronously deletes an auto follow pattern.forgetFollower
(ForgetFollowerRequest request, RequestOptions options) Deprecated.Instructs an index acting as a leader index to forget the specified follower index.forgetFollowerAsync
(ForgetFollowerRequest request, RequestOptions options, ActionListener<BroadcastResponse> listener) Deprecated.Asynchronously instructs an index acting as a leader index to forget the specified follower index.getAutoFollowPattern
(GetAutoFollowPatternRequest request, RequestOptions options) Deprecated.Gets an auto follow pattern.getAutoFollowPatternAsync
(GetAutoFollowPatternRequest request, RequestOptions options, ActionListener<GetAutoFollowPatternResponse> listener) Deprecated.Asynchronously gets an auto follow pattern.getCcrStats
(CcrStatsRequest request, RequestOptions options) Deprecated.Gets all CCR stats.getCcrStatsAsync
(CcrStatsRequest request, RequestOptions options, ActionListener<CcrStatsResponse> listener) Deprecated.Asynchronously gets all CCR stats.getFollowInfo
(FollowInfoRequest request, RequestOptions options) Deprecated.Gets follow info for specific indices.getFollowInfoAsync
(FollowInfoRequest request, RequestOptions options, ActionListener<FollowInfoResponse> listener) Deprecated.Asynchronously gets follow info for specific indices.getFollowStats
(FollowStatsRequest request, RequestOptions options) Deprecated.Gets follow stats for specific indices.getFollowStatsAsync
(FollowStatsRequest request, RequestOptions options, ActionListener<FollowStatsResponse> listener) Deprecated.Asynchronously gets follow stats for specific indices.pauseAutoFollowPattern
(PauseAutoFollowPatternRequest request, RequestOptions options) Deprecated.Pauses an auto follow pattern.pauseAutoFollowPatternAsync
(PauseAutoFollowPatternRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) Deprecated.Asynchronously pauses an auto follow pattern.pauseFollow
(PauseFollowRequest request, RequestOptions options) Deprecated.Instructs a follower index to pause the following of a leader index.pauseFollowAsync
(PauseFollowRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) Deprecated.Asynchronously instruct a follower index to pause the following of a leader index.putAutoFollowPattern
(PutAutoFollowPatternRequest request, RequestOptions options) Deprecated.Stores an auto follow pattern.putAutoFollowPatternAsync
(PutAutoFollowPatternRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) Deprecated.Asynchronously stores an auto follow pattern.putFollow
(PutFollowRequest request, RequestOptions options) Deprecated.Executes the put follow api, which creates a follower index and then the follower index starts following the leader index.putFollowAsync
(PutFollowRequest request, RequestOptions options, ActionListener<PutFollowResponse> listener) Deprecated.Asynchronously executes the put follow api, which creates a follower index and then the follower index starts following the leader index.resumeAutoFollowPattern
(ResumeAutoFollowPatternRequest request, RequestOptions options) Deprecated.Resumes an auto follow pattern.resumeAutoFollowPatternAsync
(ResumeAutoFollowPatternRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) Deprecated.Asynchronously resumes an auto follow pattern.resumeFollow
(ResumeFollowRequest request, RequestOptions options) Deprecated.Instructs a follower index to resume the following of a leader index.resumeFollowAsync
(ResumeFollowRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) Deprecated.Asynchronously instruct a follower index to resume the following of a leader index.unfollow
(UnfollowRequest request, RequestOptions options) Deprecated.Instructs a follower index to unfollow and become a regular index.unfollowAsync
(UnfollowRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) Deprecated.Asynchronously instructs a follower index to unfollow and become a regular index.
-
Method Details
-
putFollow
public PutFollowResponse putFollow(PutFollowRequest request, RequestOptions options) throws IOException Deprecated.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 requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response
- Throws:
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) Deprecated.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 requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- 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 IOException Deprecated.Instructs a follower index to pause the following of a leader index. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response
- Throws:
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) Deprecated.Asynchronously instruct a follower index to pause the following of a leader index. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- 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 IOException Deprecated.Instructs a follower index to resume the following of a leader index. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response
- Throws:
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) Deprecated.Asynchronously instruct a follower index to resume the following of a leader index. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- 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 IOException Deprecated.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 requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response
- Throws:
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) Deprecated.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 requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- 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 IOException Deprecated.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 requestoptions
- the request options (e.g., headers), useRequestOptions.DEFAULT
if the defaults are acceptable.- Returns:
- the response
- Throws:
IOException
- if an I/O exception occurs while executing this request
-
forgetFollowerAsync
public Cancellable forgetFollowerAsync(ForgetFollowerRequest request, RequestOptions options, ActionListener<BroadcastResponse> listener) Deprecated.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 requestoptions
- the request options (e.g., headers), useRequestOptions.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 IOException Deprecated.Stores an auto follow pattern. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response
- Throws:
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) Deprecated.Asynchronously stores an auto follow pattern. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- 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 IOException Deprecated.Deletes an auto follow pattern. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response
- Throws:
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) Deprecated.Asynchronously deletes an auto follow pattern. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- 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 IOException Deprecated.Gets an auto follow pattern. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response
- Throws:
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) Deprecated.Asynchronously gets an auto follow pattern. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- 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 IOException Deprecated.Pauses an auto follow pattern. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response
- Throws:
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) Deprecated.Asynchronously pauses an auto follow pattern. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- 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 IOException Deprecated.Resumes an auto follow pattern. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response
- Throws:
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) Deprecated.Asynchronously resumes an auto follow pattern. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customizedlistener
- 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 IOException Deprecated.Gets all CCR stats. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response
- Throws:
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) Deprecated.Asynchronously gets all CCR stats. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.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 IOException Deprecated.Gets follow stats for specific indices. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response
- Throws:
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) Deprecated.Asynchronously gets follow stats for specific indices. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.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 IOException Deprecated.Gets follow info for specific indices. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- the response
- Throws:
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) Deprecated.Asynchronously gets follow info for specific indices. See the docs for more.- Parameters:
request
- the requestoptions
- the request options (e.g. headers), useRequestOptions.DEFAULT
if nothing needs to be customized- Returns:
- cancellable that may be used to cancel the request
-