Package org.elasticsearch.client.ccr

Class ForgetFollowerRequest

java.lang.Object
org.elasticsearch.client.ccr.ForgetFollowerRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public final class ForgetFollowerRequest
extends java.lang.Object
implements org.elasticsearch.common.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.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

  • Field Summary

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY

  • Constructor Summary

    Constructors 
    Constructor Description
    ForgetFollowerRequest​(java.lang.String followerCluster, java.lang.String followerIndex, java.lang.String followerIndexUUID, java.lang.String leaderRemoteCluster, java.lang.String leaderIndex)
    Construct a forget follower request.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String leaderIndex()
    The name of the leader index.
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.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.common.xcontent.ToXContentObject

    isFragment

    Methods inherited from interface org.elasticsearch.client.Validatable

    validate

  • Constructor Details

    • ForgetFollowerRequest

      public ForgetFollowerRequest​(java.lang.String followerCluster, java.lang.String followerIndex, java.lang.String followerIndexUUID, java.lang.String leaderRemoteCluster, java.lang.String leaderIndex)
      Construct a forget follower request.
      Parameters:
      followerCluster - the name of the cluster containing the follower index to forget
      followerIndex - the name of follower index
      followerIndexUUID - the UUID of the follower index
      leaderRemoteCluster - the alias of the remote cluster containing the leader index from the perspective of the follower index
      leaderIndex - the name of the leader index

  • Method Details

    • leaderIndex

      public java.lang.String leaderIndex()
      The name of the leader index.
      Returns:
      the name of the leader index

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException