org.elasticsearch.client.ccr.ForgetFollowerRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch-rest-high-level-client Show documentation

Elasticsearch subproject :client:rest-high-level

There is a newer version: 8.0.0-alpha2

Show newest version

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.client.ccr;

import org.elasticsearch.client.Validatable;
import org.elasticsearch.xcontent.ToXContentObject;
import org.elasticsearch.xcontent.XContentBuilder;

import java.io.IOException;
import java.util.Objects;

/**
 * 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.
 */
public final class ForgetFollowerRequest implements ToXContentObject, Validatable {

    private final String followerCluster;

    private final String followerIndex;

    private final String followerIndexUUID;

    private final String leaderRemoteCluster;

    private final String leaderIndex;

    /**
     * The name of the leader index.
     *
     * @return the name of the leader index
     */
    public String leaderIndex() {
        return leaderIndex;
    }

    /**
     * Construct a forget follower request.
     *
     * @param followerCluster     the name of the cluster containing the follower index to forget
     * @param followerIndex       the name of follower index
     * @param followerIndexUUID   the UUID of the follower index
     * @param leaderRemoteCluster the alias of the remote cluster containing the leader index from the perspective of the follower index
     * @param leaderIndex         the name of the leader index
     */
    public ForgetFollowerRequest(
        final String followerCluster,
        final String followerIndex,
        final String followerIndexUUID,
        final String leaderRemoteCluster,
        final String leaderIndex
    ) {
        this.followerCluster = Objects.requireNonNull(followerCluster);
        this.followerIndex = Objects.requireNonNull(followerIndex);
        this.followerIndexUUID = Objects.requireNonNull(followerIndexUUID);
        this.leaderRemoteCluster = Objects.requireNonNull(leaderRemoteCluster);
        this.leaderIndex = Objects.requireNonNull(leaderIndex);
    }

    @Override
    public XContentBuilder toXContent(final XContentBuilder builder, final Params params) throws IOException {
        builder.startObject();
        {
            builder.field("follower_cluster", followerCluster);
            builder.field("follower_index", followerIndex);
            builder.field("follower_index_uuid", followerIndexUUID);
            builder.field("leader_remote_cluster", leaderRemoteCluster);
        }
        builder.endObject();
        return builder;
    }

}