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.DeleteAutoFollowPatternResponse
deleteAutoFollowPattern(java.util.function.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.FollowResponse
follow(java.util.function.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 indexFollowInfoResponse
followInfo(java.util.function.Function<FollowInfoRequest.Builder,ObjectBuilder<FollowInfoRequest>> fn)
Retrieves information about all follower indices, including parameters and status for each follower indexFollowStatsResponse
followStats(FollowStatsRequest request)
Retrieves follower stats.FollowStatsResponse
followStats(java.util.function.Function<FollowStatsRequest.Builder,ObjectBuilder<FollowStatsRequest>> fn)
Retrieves follower stats.ForgetFollowerResponse
forgetFollower(ForgetFollowerRequest request)
Removes the follower retention leases from the leader.ForgetFollowerResponse
forgetFollower(java.util.function.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.GetAutoFollowPatternResponse
getAutoFollowPattern(java.util.function.Function<GetAutoFollowPatternRequest.Builder,ObjectBuilder<GetAutoFollowPatternRequest>> fn)
Gets configured auto-follow patterns.PauseAutoFollowPatternResponse
pauseAutoFollowPattern(PauseAutoFollowPatternRequest request)
Pauses an auto-follow patternPauseAutoFollowPatternResponse
pauseAutoFollowPattern(java.util.function.Function<PauseAutoFollowPatternRequest.Builder,ObjectBuilder<PauseAutoFollowPatternRequest>> fn)
Pauses an auto-follow patternPauseFollowResponse
pauseFollow(PauseFollowRequest request)
Pauses a follower index.PauseFollowResponse
pauseFollow(java.util.function.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.PutAutoFollowPatternResponse
putAutoFollowPattern(java.util.function.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 pausedResumeAutoFollowPatternResponse
resumeAutoFollowPattern(java.util.function.Function<ResumeAutoFollowPatternRequest.Builder,ObjectBuilder<ResumeAutoFollowPatternRequest>> fn)
Resumes an auto-follow pattern that has been pausedResumeFollowResponse
resumeFollow(ResumeFollowRequest request)
Resumes a follower index that has been pausedResumeFollowResponse
resumeFollow(java.util.function.Function<ResumeFollowRequest.Builder,ObjectBuilder<ResumeFollowRequest>> fn)
Resumes a follower index that has been pausedCcrStatsResponse
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.UnfollowResponse
unfollow(java.util.function.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 optionsMethods inherited from class co.elastic.clients.ApiClient
_transport, _transportOptions, getDeserializer
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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 java.io.IOException, ElasticsearchExceptionDeletes auto-follow patterns.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
deleteAutoFollowPattern
public final DeleteAutoFollowPatternResponse deleteAutoFollowPattern(java.util.function.Function<DeleteAutoFollowPatternRequest.Builder,ObjectBuilder<DeleteAutoFollowPatternRequest>> fn) throws java.io.IOException, ElasticsearchExceptionDeletes auto-follow patterns.- Parameters:
fn
- a function that initializes a builder to create theDeleteAutoFollowPatternRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
follow
public FollowResponse follow(FollowRequest request) throws java.io.IOException, ElasticsearchExceptionCreates a new follower index configured to follow the referenced leader index.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
follow
public final FollowResponse follow(java.util.function.Function<FollowRequest.Builder,ObjectBuilder<FollowRequest>> fn) throws java.io.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:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
followInfo
public FollowInfoResponse followInfo(FollowInfoRequest request) throws java.io.IOException, ElasticsearchExceptionRetrieves information about all follower indices, including parameters and status for each follower index- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
followInfo
public final FollowInfoResponse followInfo(java.util.function.Function<FollowInfoRequest.Builder,ObjectBuilder<FollowInfoRequest>> fn) throws java.io.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:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
followStats
public FollowStatsResponse followStats(FollowStatsRequest request) throws java.io.IOException, ElasticsearchExceptionRetrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
followStats
public final FollowStatsResponse followStats(java.util.function.Function<FollowStatsRequest.Builder,ObjectBuilder<FollowStatsRequest>> fn) throws java.io.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:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
forgetFollower
public ForgetFollowerResponse forgetFollower(ForgetFollowerRequest request) throws java.io.IOException, ElasticsearchExceptionRemoves the follower retention leases from the leader.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
forgetFollower
public final ForgetFollowerResponse forgetFollower(java.util.function.Function<ForgetFollowerRequest.Builder,ObjectBuilder<ForgetFollowerRequest>> fn) throws java.io.IOException, ElasticsearchExceptionRemoves the follower retention leases from the leader.- Parameters:
fn
- a function that initializes a builder to create theForgetFollowerRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
getAutoFollowPattern
public GetAutoFollowPatternResponse getAutoFollowPattern(GetAutoFollowPatternRequest request) throws java.io.IOException, ElasticsearchExceptionGets configured auto-follow patterns. Returns the specified auto-follow pattern collection.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
getAutoFollowPattern
public final GetAutoFollowPatternResponse getAutoFollowPattern(java.util.function.Function<GetAutoFollowPatternRequest.Builder,ObjectBuilder<GetAutoFollowPatternRequest>> fn) throws java.io.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:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
getAutoFollowPattern
public GetAutoFollowPatternResponse getAutoFollowPattern() throws java.io.IOException, ElasticsearchExceptionGets configured auto-follow patterns. Returns the specified auto-follow pattern collection.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
pauseAutoFollowPattern
public PauseAutoFollowPatternResponse pauseAutoFollowPattern(PauseAutoFollowPatternRequest request) throws java.io.IOException, ElasticsearchExceptionPauses an auto-follow pattern- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
pauseAutoFollowPattern
public final PauseAutoFollowPatternResponse pauseAutoFollowPattern(java.util.function.Function<PauseAutoFollowPatternRequest.Builder,ObjectBuilder<PauseAutoFollowPatternRequest>> fn) throws java.io.IOException, ElasticsearchExceptionPauses an auto-follow pattern- Parameters:
fn
- a function that initializes a builder to create thePauseAutoFollowPatternRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
pauseFollow
public PauseFollowResponse pauseFollow(PauseFollowRequest request) throws java.io.IOException, ElasticsearchExceptionPauses a follower index. The follower index will not fetch any additional operations from the leader index.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
pauseFollow
public final PauseFollowResponse pauseFollow(java.util.function.Function<PauseFollowRequest.Builder,ObjectBuilder<PauseFollowRequest>> fn) throws java.io.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:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
putAutoFollowPattern
public PutAutoFollowPatternResponse putAutoFollowPattern(PutAutoFollowPatternRequest request) throws java.io.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.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
putAutoFollowPattern
public final PutAutoFollowPatternResponse putAutoFollowPattern(java.util.function.Function<PutAutoFollowPatternRequest.Builder,ObjectBuilder<PutAutoFollowPatternRequest>> fn) throws java.io.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:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
resumeAutoFollowPattern
public ResumeAutoFollowPatternResponse resumeAutoFollowPattern(ResumeAutoFollowPatternRequest request) throws java.io.IOException, ElasticsearchExceptionResumes an auto-follow pattern that has been paused- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
resumeAutoFollowPattern
public final ResumeAutoFollowPatternResponse resumeAutoFollowPattern(java.util.function.Function<ResumeAutoFollowPatternRequest.Builder,ObjectBuilder<ResumeAutoFollowPatternRequest>> fn) throws java.io.IOException, ElasticsearchExceptionResumes an auto-follow pattern that has been paused- Parameters:
fn
- a function that initializes a builder to create theResumeAutoFollowPatternRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
resumeFollow
public ResumeFollowResponse resumeFollow(ResumeFollowRequest request) throws java.io.IOException, ElasticsearchExceptionResumes a follower index that has been paused- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
resumeFollow
public final ResumeFollowResponse resumeFollow(java.util.function.Function<ResumeFollowRequest.Builder,ObjectBuilder<ResumeFollowRequest>> fn) throws java.io.IOException, ElasticsearchExceptionResumes a follower index that has been paused- Parameters:
fn
- a function that initializes a builder to create theResumeFollowRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
stats
Gets all stats related to cross-cluster replication.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
unfollow
public UnfollowResponse unfollow(UnfollowRequest request) throws java.io.IOException, ElasticsearchExceptionStops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
unfollow
public final UnfollowResponse unfollow(java.util.function.Function<UnfollowRequest.Builder,ObjectBuilder<UnfollowRequest>> fn) throws java.io.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:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-