Module org.elasticsearch.xcore
Class ForgetFollowerAction.Request
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.support.broadcast.BroadcastRequest<ForgetFollowerAction.Request>
org.elasticsearch.xpack.core.ccr.action.ForgetFollowerAction.Request
- All Implemented Interfaces:
IndicesRequest,IndicesRequest.Replaceable,Writeable,org.elasticsearch.core.RefCounted,TaskAwareRequest
- Enclosing class:
ForgetFollowerAction
public static class ForgetFollowerAction.Request
extends BroadcastRequest<ForgetFollowerAction.Request>
Represents a forget follower request. Note that this an expert API intended to be used only when unfollowing a follower index fails
to emove 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.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
Fields inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest
DEFAULT_INDICES_OPTIONS, indicesFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe name of the cluster containing the follower index.The name of the follower index.The UUID of the follower index.static ForgetFollowerAction.RequestfromXContent(org.elasticsearch.xcontent.XContentParser parser, String leaderIndex) booleanThe name of the leader index.The alias of the remote cluster containing the leader index.voidwriteTo(StreamOutput out) Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest
indices, indices, indicesOptions, indicesOptions, timeout, timeout, validateMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestId, toStringMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable
allowsRemoteIndicesMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
Request
- Throws:
IOException
-
Request
public Request(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
-
fromXContent
public static ForgetFollowerAction.Request fromXContent(org.elasticsearch.xcontent.XContentParser parser, String leaderIndex) throws IOException - Throws:
IOException
-
followerCluster
The name of the cluster containing the follower index.- Returns:
- the name of the cluster containing the follower index
-
followerIndex
The name of the follower index.- Returns:
- the name of the follower index
-
followerIndexUUID
The UUID of the follower index.- Returns:
- the UUID of the follower index
-
leaderRemoteCluster
The alias of the remote cluster containing the leader index.- Returns:
- the alias of the remote cluster
-
leaderIndex
The name of the leader index.- Returns:
- the name of the leader index
-
writeTo
- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classBroadcastRequest<ForgetFollowerAction.Request>- Throws:
IOException
-
includeDataStreams
public boolean includeDataStreams()- Specified by:
includeDataStreamsin interfaceIndicesRequest- Overrides:
includeDataStreamsin classBroadcastRequest<ForgetFollowerAction.Request>
-