Package co.elastic.clients.elasticsearch.ccr

Class ElasticsearchCcrClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchCcrClient>

co.elastic.clients.elasticsearch.ccr.ElasticsearchCcrClient

public class ElasticsearchCcrClient
extends ApiClient<ElasticsearchTransport,ElasticsearchCcrClient>

Client for the ccr namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchCcrClient(ElasticsearchTransport transport)
ElasticsearchCcrClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
DeleteAutoFollowPatternResponse	deleteAutoFollowPattern(DeleteAutoFollowPatternRequest request)	Deletes auto-follow patterns.
final DeleteAutoFollowPatternResponse	deleteAutoFollowPattern(Function<DeleteAutoFollowPatternRequest.Builder,ObjectBuilder<DeleteAutoFollowPatternRequest>> fn)	Deletes auto-follow patterns.
FollowResponse	follow(FollowRequest request)	Creates a new follower index configured to follow the referenced leader index.
final FollowResponse	follow(Function<FollowRequest.Builder,ObjectBuilder<FollowRequest>> fn)	Creates a new follower index configured to follow the referenced leader index.
FollowInfoResponse	followInfo(FollowInfoRequest request)	Retrieves information about all follower indices, including parameters and status for each follower index
final FollowInfoResponse	followInfo(Function<FollowInfoRequest.Builder,ObjectBuilder<FollowInfoRequest>> fn)	Retrieves information about all follower indices, including parameters and status for each follower index
FollowStatsResponse	followStats(FollowStatsRequest request)	Retrieves follower stats.
final FollowStatsResponse	followStats(Function<FollowStatsRequest.Builder,ObjectBuilder<FollowStatsRequest>> fn)	Retrieves follower stats.
ForgetFollowerResponse	forgetFollower(ForgetFollowerRequest request)	Removes the follower retention leases from the leader.
final ForgetFollowerResponse	forgetFollower(Function<ForgetFollowerRequest.Builder,ObjectBuilder<ForgetFollowerRequest>> fn)	Removes the follower retention leases from the leader.
GetAutoFollowPatternResponse	getAutoFollowPattern()	Gets configured auto-follow patterns.
GetAutoFollowPatternResponse	getAutoFollowPattern(GetAutoFollowPatternRequest request)	Gets configured auto-follow patterns.
final GetAutoFollowPatternResponse	getAutoFollowPattern(Function<GetAutoFollowPatternRequest.Builder,ObjectBuilder<GetAutoFollowPatternRequest>> fn)	Gets configured auto-follow patterns.
PauseAutoFollowPatternResponse	pauseAutoFollowPattern(PauseAutoFollowPatternRequest request)	Pauses an auto-follow pattern
final PauseAutoFollowPatternResponse	pauseAutoFollowPattern(Function<PauseAutoFollowPatternRequest.Builder,ObjectBuilder<PauseAutoFollowPatternRequest>> fn)	Pauses an auto-follow pattern
PauseFollowResponse	pauseFollow(PauseFollowRequest request)	Pauses a follower index.
final PauseFollowResponse	pauseFollow(Function<PauseFollowRequest.Builder,ObjectBuilder<PauseFollowRequest>> fn)	Pauses a follower index.
PutAutoFollowPatternResponse	putAutoFollowPattern(PutAutoFollowPatternRequest request)	Creates a new named collection of auto-follow patterns against a specified remote cluster.
final PutAutoFollowPatternResponse	putAutoFollowPattern(Function<PutAutoFollowPatternRequest.Builder,ObjectBuilder<PutAutoFollowPatternRequest>> fn)	Creates a new named collection of auto-follow patterns against a specified remote cluster.
ResumeAutoFollowPatternResponse	resumeAutoFollowPattern(ResumeAutoFollowPatternRequest request)	Resumes an auto-follow pattern that has been paused
final ResumeAutoFollowPatternResponse	resumeAutoFollowPattern(Function<ResumeAutoFollowPatternRequest.Builder,ObjectBuilder<ResumeAutoFollowPatternRequest>> fn)	Resumes an auto-follow pattern that has been paused
ResumeFollowResponse	resumeFollow(ResumeFollowRequest request)	Resumes a follower index that has been paused
final ResumeFollowResponse	resumeFollow(Function<ResumeFollowRequest.Builder,ObjectBuilder<ResumeFollowRequest>> fn)	Resumes a follower index that has been paused
CcrStatsResponse	stats()	Gets all stats related to cross-cluster replication.
UnfollowResponse	unfollow(UnfollowRequest request)	Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.
final UnfollowResponse	unfollow(Function<UnfollowRequest.Builder,ObjectBuilder<UnfollowRequest>> fn)	Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.
ElasticsearchCcrClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchCcrClient

public ElasticsearchCcrClient(ElasticsearchTransport transport)

ElasticsearchCcrClient

public ElasticsearchCcrClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchCcrClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchCcrClient>

deleteAutoFollowPattern

public DeleteAutoFollowPatternResponse deleteAutoFollowPattern(DeleteAutoFollowPatternRequest request)
                                                        throws IOException,
ElasticsearchException

Deletes auto-follow patterns.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteAutoFollowPattern

public final DeleteAutoFollowPatternResponse deleteAutoFollowPattern(Function<DeleteAutoFollowPatternRequest.Builder,ObjectBuilder<DeleteAutoFollowPatternRequest>> fn)
                                                              throws IOException,
ElasticsearchException

Deletes auto-follow patterns.

Parameters:

fn - a function that initializes a builder to create the DeleteAutoFollowPatternRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

follow

public FollowResponse follow(FollowRequest request)
                      throws IOException,
ElasticsearchException

Creates a new follower index configured to follow the referenced leader index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

follow

public final FollowResponse follow(Function<FollowRequest.Builder,ObjectBuilder<FollowRequest>> fn)
                            throws IOException,
ElasticsearchException

Creates a new follower index configured to follow the referenced leader index.

Parameters:

fn - a function that initializes a builder to create the FollowRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

followInfo

public FollowInfoResponse followInfo(FollowInfoRequest request)
                              throws IOException,
ElasticsearchException

Retrieves information about all follower indices, including parameters and status for each follower index

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

followInfo

public final FollowInfoResponse followInfo(Function<FollowInfoRequest.Builder,ObjectBuilder<FollowInfoRequest>> fn)
                                    throws IOException,
ElasticsearchException

Retrieves information about all follower indices, including parameters and status for each follower index

Parameters:

fn - a function that initializes a builder to create the FollowInfoRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

followStats

public FollowStatsResponse followStats(FollowStatsRequest request)
                                throws IOException,
ElasticsearchException

Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

followStats

public final FollowStatsResponse followStats(Function<FollowStatsRequest.Builder,ObjectBuilder<FollowStatsRequest>> fn)
                                      throws IOException,
ElasticsearchException

Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.

Parameters:

fn - a function that initializes a builder to create the FollowStatsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

forgetFollower

public ForgetFollowerResponse forgetFollower(ForgetFollowerRequest request)
                                      throws IOException,
ElasticsearchException

Removes the follower retention leases from the leader.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

forgetFollower

public final ForgetFollowerResponse forgetFollower(Function<ForgetFollowerRequest.Builder,ObjectBuilder<ForgetFollowerRequest>> fn)
                                            throws IOException,
ElasticsearchException

Removes the follower retention leases from the leader.

Parameters:

fn - a function that initializes a builder to create the ForgetFollowerRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAutoFollowPattern

public GetAutoFollowPatternResponse getAutoFollowPattern(GetAutoFollowPatternRequest request)
                                                  throws IOException,
ElasticsearchException

Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAutoFollowPattern

public final GetAutoFollowPatternResponse getAutoFollowPattern(Function<GetAutoFollowPatternRequest.Builder,ObjectBuilder<GetAutoFollowPatternRequest>> fn)
                                                        throws IOException,
ElasticsearchException

Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.

Parameters:

fn - a function that initializes a builder to create the GetAutoFollowPatternRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getAutoFollowPattern

public GetAutoFollowPatternResponse getAutoFollowPattern()
                                                  throws IOException,
ElasticsearchException

Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

pauseAutoFollowPattern

public PauseAutoFollowPatternResponse pauseAutoFollowPattern(PauseAutoFollowPatternRequest request)
                                                      throws IOException,
ElasticsearchException

Pauses an auto-follow pattern

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

pauseAutoFollowPattern

public final PauseAutoFollowPatternResponse pauseAutoFollowPattern(Function<PauseAutoFollowPatternRequest.Builder,ObjectBuilder<PauseAutoFollowPatternRequest>> fn)
                                                            throws IOException,
ElasticsearchException

Pauses an auto-follow pattern

Parameters:

fn - a function that initializes a builder to create the PauseAutoFollowPatternRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

pauseFollow

public PauseFollowResponse pauseFollow(PauseFollowRequest request)
                                throws IOException,
ElasticsearchException

Pauses a follower index. The follower index will not fetch any additional operations from the leader index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

pauseFollow

public final PauseFollowResponse pauseFollow(Function<PauseFollowRequest.Builder,ObjectBuilder<PauseFollowRequest>> fn)
                                      throws IOException,
ElasticsearchException

Pauses a follower index. The follower index will not fetch any additional operations from the leader index.

Parameters:

fn - a function that initializes a builder to create the PauseFollowRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putAutoFollowPattern

public PutAutoFollowPatternResponse putAutoFollowPattern(PutAutoFollowPatternRequest request)
                                                  throws IOException,
ElasticsearchException

Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putAutoFollowPattern

public final PutAutoFollowPatternResponse putAutoFollowPattern(Function<PutAutoFollowPatternRequest.Builder,ObjectBuilder<PutAutoFollowPatternRequest>> fn)
                                                        throws IOException,
ElasticsearchException

Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.

Parameters:

fn - a function that initializes a builder to create the PutAutoFollowPatternRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resumeAutoFollowPattern

public ResumeAutoFollowPatternResponse resumeAutoFollowPattern(ResumeAutoFollowPatternRequest request)
                                                        throws IOException,
ElasticsearchException

Resumes an auto-follow pattern that has been paused

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resumeAutoFollowPattern

public final ResumeAutoFollowPatternResponse resumeAutoFollowPattern(Function<ResumeAutoFollowPatternRequest.Builder,ObjectBuilder<ResumeAutoFollowPatternRequest>> fn)
                                                              throws IOException,
ElasticsearchException

Resumes an auto-follow pattern that has been paused

Parameters:

fn - a function that initializes a builder to create the ResumeAutoFollowPatternRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resumeFollow

public ResumeFollowResponse resumeFollow(ResumeFollowRequest request)
                                  throws IOException,
ElasticsearchException

Resumes a follower index that has been paused

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resumeFollow

public final ResumeFollowResponse resumeFollow(Function<ResumeFollowRequest.Builder,ObjectBuilder<ResumeFollowRequest>> fn)
                                        throws IOException,
ElasticsearchException

Resumes a follower index that has been paused

Parameters:

fn - a function that initializes a builder to create the ResumeFollowRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public CcrStatsResponse stats()
                       throws IOException,
ElasticsearchException

Gets all stats related to cross-cluster replication.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

unfollow

public UnfollowResponse unfollow(UnfollowRequest request)
                          throws IOException,
ElasticsearchException

Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

unfollow

public final UnfollowResponse unfollow(Function<UnfollowRequest.Builder,ObjectBuilder<UnfollowRequest>> fn)
                                throws IOException,
ElasticsearchException

Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.

Parameters:

fn - a function that initializes a builder to create the UnfollowRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co