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
ConstructorDescriptionElasticsearchCcrClient
(ElasticsearchTransport transport) ElasticsearchCcrClient
(ElasticsearchTransport transport, TransportOptions transportOptions) -
Method Summary
Modifier and TypeMethodDescriptionDeletes auto-follow patterns.deleteAutoFollowPattern
(Function<DeleteAutoFollowPatternRequest.Builder, ObjectBuilder<DeleteAutoFollowPatternRequest>> fn) Deletes auto-follow patterns.follow
(FollowRequest request) Creates a new follower index configured to follow the referenced leader index.final FollowResponse
Creates a new follower index configured to follow the referenced leader index.followInfo
(FollowInfoRequest request) Retrieves information about all follower indices, including parameters and status for each follower indexfinal FollowInfoResponse
Retrieves information about all follower indices, including parameters and status for each follower indexfollowStats
(FollowStatsRequest request) Retrieves follower stats.final FollowStatsResponse
Retrieves follower stats.forgetFollower
(ForgetFollowerRequest request) Removes the follower retention leases from the leader.final ForgetFollowerResponse
Removes the follower retention leases from the leader.Gets configured auto-follow patterns.Gets configured auto-follow patterns.getAutoFollowPattern
(Function<GetAutoFollowPatternRequest.Builder, ObjectBuilder<GetAutoFollowPatternRequest>> fn) Gets configured auto-follow patterns.Pauses an auto-follow patternpauseAutoFollowPattern
(Function<PauseAutoFollowPatternRequest.Builder, ObjectBuilder<PauseAutoFollowPatternRequest>> fn) Pauses an auto-follow patternpauseFollow
(PauseFollowRequest request) Pauses a follower index.final PauseFollowResponse
Pauses a follower index.Creates a new named collection of auto-follow patterns against a specified remote cluster.putAutoFollowPattern
(Function<PutAutoFollowPatternRequest.Builder, ObjectBuilder<PutAutoFollowPatternRequest>> fn) Creates a new named collection of auto-follow patterns against a specified remote cluster.Resumes an auto-follow pattern that has been pausedresumeAutoFollowPattern
(Function<ResumeAutoFollowPatternRequest.Builder, ObjectBuilder<ResumeAutoFollowPatternRequest>> fn) Resumes an auto-follow pattern that has been pausedresumeFollow
(ResumeFollowRequest request) Resumes a follower index that has been pausedfinal ResumeFollowResponse
Resumes a follower index that has been pausedstats()
Gets all stats related to cross-cluster replication.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
Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.withTransportOptions
(TransportOptions transportOptions) Creates a new client with some request optionsMethods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions
-
Constructor Details
-
ElasticsearchCcrClient
-
ElasticsearchCcrClient
public ElasticsearchCcrClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
withTransportOptions
Description copied from class:ApiClient
Creates a new client with some request options- Specified by:
withTransportOptions
in classApiClient<ElasticsearchTransport,
ElasticsearchCcrClient>
-
deleteAutoFollowPattern
public DeleteAutoFollowPatternResponse deleteAutoFollowPattern(DeleteAutoFollowPatternRequest request) throws IOException, ElasticsearchException Deletes auto-follow patterns.- Throws:
IOException
ElasticsearchException
- See Also:
-
deleteAutoFollowPattern
public final DeleteAutoFollowPatternResponse deleteAutoFollowPattern(Function<DeleteAutoFollowPatternRequest.Builder, ObjectBuilder<DeleteAutoFollowPatternRequest>> fn) throws IOException, ElasticsearchExceptionDeletes auto-follow patterns.- Parameters:
fn
- a function that initializes a builder to create theDeleteAutoFollowPatternRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
follow
Creates a new follower index configured to follow the referenced leader index.- Throws:
IOException
ElasticsearchException
- See Also:
-
follow
public final FollowResponse follow(Function<FollowRequest.Builder, ObjectBuilder<FollowRequest>> fn) throws IOException, ElasticsearchExceptionCreates a new follower index configured to follow the referenced leader index.- Parameters:
fn
- a function that initializes a builder to create theFollowRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
followInfo
public final FollowInfoResponse followInfo(Function<FollowInfoRequest.Builder, ObjectBuilder<FollowInfoRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves information about all follower indices, including parameters and status for each follower index- Parameters:
fn
- a function that initializes a builder to create theFollowInfoRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
followStats
public final FollowStatsResponse followStats(Function<FollowStatsRequest.Builder, ObjectBuilder<FollowStatsRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves 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 theFollowStatsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
forgetFollower
public ForgetFollowerResponse forgetFollower(ForgetFollowerRequest request) throws IOException, ElasticsearchException Removes the follower retention leases from the leader.- Throws:
IOException
ElasticsearchException
- See Also:
-
forgetFollower
public final ForgetFollowerResponse forgetFollower(Function<ForgetFollowerRequest.Builder, ObjectBuilder<ForgetFollowerRequest>> fn) throws IOException, ElasticsearchExceptionRemoves the follower retention leases from the leader.- Parameters:
fn
- a function that initializes a builder to create theForgetFollowerRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
getAutoFollowPattern
public final GetAutoFollowPatternResponse getAutoFollowPattern(Function<GetAutoFollowPatternRequest.Builder, ObjectBuilder<GetAutoFollowPatternRequest>> fn) throws IOException, ElasticsearchExceptionGets configured auto-follow patterns. Returns the specified auto-follow pattern collection.- Parameters:
fn
- a function that initializes a builder to create theGetAutoFollowPatternRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getAutoFollowPattern
public GetAutoFollowPatternResponse getAutoFollowPattern() throws IOException, ElasticsearchExceptionGets configured auto-follow patterns. Returns the specified auto-follow pattern collection.- Throws:
IOException
ElasticsearchException
- See Also:
-
pauseAutoFollowPattern
public PauseAutoFollowPatternResponse pauseAutoFollowPattern(PauseAutoFollowPatternRequest request) throws IOException, ElasticsearchException Pauses an auto-follow pattern- Throws:
IOException
ElasticsearchException
- See Also:
-
pauseAutoFollowPattern
public final PauseAutoFollowPatternResponse pauseAutoFollowPattern(Function<PauseAutoFollowPatternRequest.Builder, ObjectBuilder<PauseAutoFollowPatternRequest>> fn) throws IOException, ElasticsearchExceptionPauses an auto-follow pattern- Parameters:
fn
- a function that initializes a builder to create thePauseAutoFollowPatternRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
pauseFollow
public final PauseFollowResponse pauseFollow(Function<PauseFollowRequest.Builder, ObjectBuilder<PauseFollowRequest>> fn) throws IOException, ElasticsearchExceptionPauses 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 thePauseFollowRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
putAutoFollowPattern
public final PutAutoFollowPatternResponse putAutoFollowPattern(Function<PutAutoFollowPatternRequest.Builder, ObjectBuilder<PutAutoFollowPatternRequest>> fn) throws IOException, ElasticsearchExceptionCreates 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 thePutAutoFollowPatternRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
resumeAutoFollowPattern
public ResumeAutoFollowPatternResponse resumeAutoFollowPattern(ResumeAutoFollowPatternRequest request) throws IOException, ElasticsearchException Resumes an auto-follow pattern that has been paused- Throws:
IOException
ElasticsearchException
- See Also:
-
resumeAutoFollowPattern
public final ResumeAutoFollowPatternResponse resumeAutoFollowPattern(Function<ResumeAutoFollowPatternRequest.Builder, ObjectBuilder<ResumeAutoFollowPatternRequest>> fn) throws IOException, ElasticsearchExceptionResumes an auto-follow pattern that has been paused- Parameters:
fn
- a function that initializes a builder to create theResumeAutoFollowPatternRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
resumeFollow
public ResumeFollowResponse resumeFollow(ResumeFollowRequest request) throws IOException, ElasticsearchException Resumes a follower index that has been paused- Throws:
IOException
ElasticsearchException
- See Also:
-
resumeFollow
public final ResumeFollowResponse resumeFollow(Function<ResumeFollowRequest.Builder, ObjectBuilder<ResumeFollowRequest>> fn) throws IOException, ElasticsearchExceptionResumes a follower index that has been paused- Parameters:
fn
- a function that initializes a builder to create theResumeFollowRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
stats
Gets all stats related to cross-cluster replication.- Throws:
IOException
ElasticsearchException
- See Also:
-
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:
-
unfollow
public final UnfollowResponse unfollow(Function<UnfollowRequest.Builder, ObjectBuilder<UnfollowRequest>> fn) throws IOException, ElasticsearchExceptionStops 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 theUnfollowRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-