Package org.elasticsearch.client.ccr
Class ForgetFollowerRequest
java.lang.Object
org.elasticsearch.client.ccr.ForgetFollowerRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public final class ForgetFollowerRequest
extends Object
implements org.elasticsearch.xcontent.ToXContentObject, Validatable
Represents a forget follower request. Note that this an expert API intended to be used only when unfollowing a follower index fails to
remove the follower retention leases. Please be sure that you understand the purpose this API before using.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
-
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the leader index.org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Constructor Details
-
ForgetFollowerRequest
public ForgetFollowerRequest(String followerCluster, String followerIndex, String followerIndexUUID, String leaderRemoteCluster, String leaderIndex) Construct a forget follower request.- Parameters:
followerCluster
- the name of the cluster containing the follower index to forgetfollowerIndex
- the name of follower indexfollowerIndexUUID
- the UUID of the follower indexleaderRemoteCluster
- the alias of the remote cluster containing the leader index from the perspective of the follower indexleaderIndex
- the name of the leader index
-
-
Method Details
-
leaderIndex
The name of the leader index.- Returns:
- the name of the leader index
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-