Package co.elastic.clients.elasticsearch.ccr

Class ElasticsearchCcrAsyncClient

java.lang.Object

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

co.elastic.clients.elasticsearch.ccr.ElasticsearchCcrAsyncClient

public class ElasticsearchCcrAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchCcrAsyncClient>

Client for the ccr namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CompletableFuture<DeleteAutoFollowPatternResponse>	deleteAutoFollowPattern(DeleteAutoFollowPatternRequest request)	Deletes auto-follow patterns.
final CompletableFuture<DeleteAutoFollowPatternResponse>	deleteAutoFollowPattern(Function<DeleteAutoFollowPatternRequest.Builder,ObjectBuilder<DeleteAutoFollowPatternRequest>> fn)	Deletes auto-follow patterns.
CompletableFuture<FollowResponse>	follow(FollowRequest request)	Creates a new follower index configured to follow the referenced leader index.
final CompletableFuture<FollowResponse>	follow(Function<FollowRequest.Builder,ObjectBuilder<FollowRequest>> fn)	Creates a new follower index configured to follow the referenced leader index.
CompletableFuture<FollowInfoResponse>	followInfo(FollowInfoRequest request)	Retrieves information about all follower indices, including parameters and status for each follower index
final CompletableFuture<FollowInfoResponse>	followInfo(Function<FollowInfoRequest.Builder,ObjectBuilder<FollowInfoRequest>> fn)	Retrieves information about all follower indices, including parameters and status for each follower index
CompletableFuture<FollowStatsResponse>	followStats(FollowStatsRequest request)	Retrieves follower stats.
final CompletableFuture<FollowStatsResponse>	followStats(Function<FollowStatsRequest.Builder,ObjectBuilder<FollowStatsRequest>> fn)	Retrieves follower stats.
CompletableFuture<ForgetFollowerResponse>	forgetFollower(ForgetFollowerRequest request)	Removes the follower retention leases from the leader.
final CompletableFuture<ForgetFollowerResponse>	forgetFollower(Function<ForgetFollowerRequest.Builder,ObjectBuilder<ForgetFollowerRequest>> fn)	Removes the follower retention leases from the leader.
CompletableFuture<GetAutoFollowPatternResponse>	getAutoFollowPattern()	Gets configured auto-follow patterns.
CompletableFuture<GetAutoFollowPatternResponse>	getAutoFollowPattern(GetAutoFollowPatternRequest request)	Gets configured auto-follow patterns.
final CompletableFuture<GetAutoFollowPatternResponse>	getAutoFollowPattern(Function<GetAutoFollowPatternRequest.Builder,ObjectBuilder<GetAutoFollowPatternRequest>> fn)	Gets configured auto-follow patterns.
CompletableFuture<PauseAutoFollowPatternResponse>	pauseAutoFollowPattern(PauseAutoFollowPatternRequest request)	Pauses an auto-follow pattern
final CompletableFuture<PauseAutoFollowPatternResponse>	pauseAutoFollowPattern(Function<PauseAutoFollowPatternRequest.Builder,ObjectBuilder<PauseAutoFollowPatternRequest>> fn)	Pauses an auto-follow pattern
CompletableFuture<PauseFollowResponse>	pauseFollow(PauseFollowRequest request)	Pauses a follower index.
final CompletableFuture<PauseFollowResponse>	pauseFollow(Function<PauseFollowRequest.Builder,ObjectBuilder<PauseFollowRequest>> fn)	Pauses a follower index.
CompletableFuture<PutAutoFollowPatternResponse>	putAutoFollowPattern(PutAutoFollowPatternRequest request)	Creates a new named collection of auto-follow patterns against a specified remote cluster.
final CompletableFuture<PutAutoFollowPatternResponse>	putAutoFollowPattern(Function<PutAutoFollowPatternRequest.Builder,ObjectBuilder<PutAutoFollowPatternRequest>> fn)	Creates a new named collection of auto-follow patterns against a specified remote cluster.
CompletableFuture<ResumeAutoFollowPatternResponse>	resumeAutoFollowPattern(ResumeAutoFollowPatternRequest request)	Resumes an auto-follow pattern that has been paused
final CompletableFuture<ResumeAutoFollowPatternResponse>	resumeAutoFollowPattern(Function<ResumeAutoFollowPatternRequest.Builder,ObjectBuilder<ResumeAutoFollowPatternRequest>> fn)	Resumes an auto-follow pattern that has been paused
CompletableFuture<ResumeFollowResponse>	resumeFollow(ResumeFollowRequest request)	Resumes a follower index that has been paused
final CompletableFuture<ResumeFollowResponse>	resumeFollow(Function<ResumeFollowRequest.Builder,ObjectBuilder<ResumeFollowRequest>> fn)	Resumes a follower index that has been paused
CompletableFuture<CcrStatsResponse>	stats()	Gets all stats related to cross-cluster replication.
CompletableFuture<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 CompletableFuture<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.
ElasticsearchCcrAsyncClient	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

ElasticsearchCcrAsyncClient

public ElasticsearchCcrAsyncClient(ElasticsearchTransport transport)

ElasticsearchCcrAsyncClient

public ElasticsearchCcrAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchCcrAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchCcrAsyncClient>

deleteAutoFollowPattern

public CompletableFuture<DeleteAutoFollowPatternResponse> deleteAutoFollowPattern(DeleteAutoFollowPatternRequest request)

Deletes auto-follow patterns.

See Also:

• Documentation on elastic.co

deleteAutoFollowPattern

public final CompletableFuture<DeleteAutoFollowPatternResponse> deleteAutoFollowPattern(Function<DeleteAutoFollowPatternRequest.Builder,ObjectBuilder<DeleteAutoFollowPatternRequest>> fn)

Deletes auto-follow patterns.

Parameters:

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

See Also:

• Documentation on elastic.co

follow

public CompletableFuture<FollowResponse> follow(FollowRequest request)

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

See Also:

• Documentation on elastic.co

follow

public final CompletableFuture<FollowResponse> follow(Function<FollowRequest.Builder,ObjectBuilder<FollowRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

followInfo

public CompletableFuture<FollowInfoResponse> followInfo(FollowInfoRequest request)

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

See Also:

• Documentation on elastic.co

followInfo

public final CompletableFuture<FollowInfoResponse> followInfo(Function<FollowInfoRequest.Builder,ObjectBuilder<FollowInfoRequest>> fn)

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

See Also:

• Documentation on elastic.co

followStats

public CompletableFuture<FollowStatsResponse> followStats(FollowStatsRequest request)

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

See Also:

• Documentation on elastic.co

followStats

public final CompletableFuture<FollowStatsResponse> followStats(Function<FollowStatsRequest.Builder,ObjectBuilder<FollowStatsRequest>> fn)

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

See Also:

• Documentation on elastic.co

forgetFollower

public CompletableFuture<ForgetFollowerResponse> forgetFollower(ForgetFollowerRequest request)

Removes the follower retention leases from the leader.

See Also:

• Documentation on elastic.co

forgetFollower

public final CompletableFuture<ForgetFollowerResponse> forgetFollower(Function<ForgetFollowerRequest.Builder,ObjectBuilder<ForgetFollowerRequest>> fn)

Removes the follower retention leases from the leader.

Parameters:

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

See Also:

• Documentation on elastic.co

getAutoFollowPattern

public CompletableFuture<GetAutoFollowPatternResponse> getAutoFollowPattern(GetAutoFollowPatternRequest request)

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

See Also:

• Documentation on elastic.co

getAutoFollowPattern

public final CompletableFuture<GetAutoFollowPatternResponse> getAutoFollowPattern(Function<GetAutoFollowPatternRequest.Builder,ObjectBuilder<GetAutoFollowPatternRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

getAutoFollowPattern

public CompletableFuture<GetAutoFollowPatternResponse> getAutoFollowPattern()

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

See Also:

• Documentation on elastic.co

pauseAutoFollowPattern

public CompletableFuture<PauseAutoFollowPatternResponse> pauseAutoFollowPattern(PauseAutoFollowPatternRequest request)

Pauses an auto-follow pattern

See Also:

• Documentation on elastic.co

pauseAutoFollowPattern

public final CompletableFuture<PauseAutoFollowPatternResponse> pauseAutoFollowPattern(Function<PauseAutoFollowPatternRequest.Builder,ObjectBuilder<PauseAutoFollowPatternRequest>> fn)

Pauses an auto-follow pattern

Parameters:

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

See Also:

• Documentation on elastic.co

pauseFollow

public CompletableFuture<PauseFollowResponse> pauseFollow(PauseFollowRequest request)

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

See Also:

• Documentation on elastic.co

pauseFollow

public final CompletableFuture<PauseFollowResponse> pauseFollow(Function<PauseFollowRequest.Builder,ObjectBuilder<PauseFollowRequest>> fn)

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

See Also:

• Documentation on elastic.co

putAutoFollowPattern

public CompletableFuture<PutAutoFollowPatternResponse> putAutoFollowPattern(PutAutoFollowPatternRequest request)

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.

See Also:

• Documentation on elastic.co

putAutoFollowPattern

public final CompletableFuture<PutAutoFollowPatternResponse> putAutoFollowPattern(Function<PutAutoFollowPatternRequest.Builder,ObjectBuilder<PutAutoFollowPatternRequest>> fn)

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

See Also:

• Documentation on elastic.co

resumeAutoFollowPattern

public CompletableFuture<ResumeAutoFollowPatternResponse> resumeAutoFollowPattern(ResumeAutoFollowPatternRequest request)

Resumes an auto-follow pattern that has been paused

See Also:

• Documentation on elastic.co

resumeAutoFollowPattern

public final CompletableFuture<ResumeAutoFollowPatternResponse> resumeAutoFollowPattern(Function<ResumeAutoFollowPatternRequest.Builder,ObjectBuilder<ResumeAutoFollowPatternRequest>> fn)

Resumes an auto-follow pattern that has been paused

Parameters:

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

See Also:

• Documentation on elastic.co

resumeFollow

public CompletableFuture<ResumeFollowResponse> resumeFollow(ResumeFollowRequest request)

Resumes a follower index that has been paused

See Also:

• Documentation on elastic.co

resumeFollow

public final CompletableFuture<ResumeFollowResponse> resumeFollow(Function<ResumeFollowRequest.Builder,ObjectBuilder<ResumeFollowRequest>> fn)

Resumes a follower index that has been paused

Parameters:

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

See Also:

• Documentation on elastic.co

stats

public CompletableFuture<CcrStatsResponse> stats()

Gets all stats related to cross-cluster replication.

See Also:

• Documentation on elastic.co

unfollow

public CompletableFuture<UnfollowResponse> unfollow(UnfollowRequest request)

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

See Also:

• Documentation on elastic.co

unfollow

public final CompletableFuture<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.

Parameters:

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

See Also:

• Documentation on elastic.co