org.elasticsearch.action.admin.indices.rollover.RolloverResponse Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :core
There is a newer version: 8.14.1
/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.action.admin.indices.rollover;

import org.elasticsearch.action.ActionResponse;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.xcontent.ToXContentObject;
import org.elasticsearch.common.xcontent.XContentBuilder;

import java.io.IOException;
import java.util.AbstractMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

public final class RolloverResponse extends ActionResponse implements ToXContentObject {

    private static final String NEW_INDEX = "new_index";
    private static final String OLD_INDEX = "old_index";
    private static final String DRY_RUN = "dry_run";
    private static final String ROLLED_OVER = "rolled_over";
    private static final String CONDITIONS = "conditions";
    private static final String ACKNOWLEDGED = "acknowledged";
    private static final String SHARDS_ACKED = "shards_acknowledged";

    private String oldIndex;
    private String newIndex;
    private Set> conditionStatus;
    private boolean dryRun;
    private boolean rolledOver;
    private boolean acknowledged;
    private boolean shardsAcked;

    RolloverResponse() {
    }

    RolloverResponse(String oldIndex, String newIndex, Set conditionResults,
                     boolean dryRun, boolean rolledOver, boolean acknowledged, boolean shardsAcked) {
        this.oldIndex = oldIndex;
        this.newIndex = newIndex;
        this.dryRun = dryRun;
        this.rolledOver = rolledOver;
        this.acknowledged = acknowledged;
        this.shardsAcked = shardsAcked;
        this.conditionStatus = conditionResults.stream()
            .map(result -> new AbstractMap.SimpleEntry<>(result.condition.toString(), result.matched))
            .collect(Collectors.toSet());
    }

    /**
     * Returns the name of the index that the request alias was pointing to
     */
    public String getOldIndex() {
        return oldIndex;
    }

    /**
     * Returns the name of the index that the request alias currently points to
     */
    public String getNewIndex() {
        return newIndex;
    }

    /**
     * Returns the statuses of all the request conditions
     */
    public Set> getConditionStatus() {
        return conditionStatus;
    }

    /**
     * Returns if the rollover execution was skipped even when conditions were met
     */
    public boolean isDryRun() {
        return dryRun;
    }

    /**
     * Returns true if the rollover was not simulated and the conditions were met
     */
    public boolean isRolledOver() {
        return rolledOver;
    }

    /**
     * Returns true if the creation of the new rollover index and switching of the
     * alias to the newly created index was successful, and returns false otherwise.
     * If {@link #isDryRun()} is true, then this will also return false. If this
     * returns false, then {@link #isShardsAcked()} will also return false.
     */
    public boolean isAcknowledged() {
        return acknowledged;
    }

    /**
     * Returns true if the requisite number of shards were started in the newly
     * created rollover index before returning.  If {@link #isAcknowledged()} is
     * false, then this will also return false.
     */
    public boolean isShardsAcked() {
        return shardsAcked;
    }

    @Override
    public void readFrom(StreamInput in) throws IOException {
        super.readFrom(in);
        oldIndex = in.readString();
        newIndex = in.readString();
        int conditionSize = in.readVInt();
        Set> conditions = new HashSet<>(conditionSize);
        for (int i = 0; i < conditionSize; i++) {
            String condition = in.readString();
            boolean satisfied = in.readBoolean();
            conditions.add(new AbstractMap.SimpleEntry<>(condition, satisfied));
        }
        conditionStatus = conditions;
        dryRun = in.readBoolean();
        rolledOver = in.readBoolean();
        acknowledged = in.readBoolean();
        shardsAcked = in.readBoolean();
    }

    @Override
    public void writeTo(StreamOutput out) throws IOException {
        super.writeTo(out);
        out.writeString(oldIndex);
        out.writeString(newIndex);
        out.writeVInt(conditionStatus.size());
        for (Map.Entry entry : conditionStatus) {
            out.writeString(entry.getKey());
            out.writeBoolean(entry.getValue());
        }
        out.writeBoolean(dryRun);
        out.writeBoolean(rolledOver);
        out.writeBoolean(acknowledged);
        out.writeBoolean(shardsAcked);
    }

    @Override
    public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
        builder.startObject();
        builder.field(OLD_INDEX, oldIndex);
        builder.field(NEW_INDEX, newIndex);
        builder.field(ROLLED_OVER, rolledOver);
        builder.field(DRY_RUN, dryRun);
        builder.field(ACKNOWLEDGED, acknowledged);
        builder.field(SHARDS_ACKED, shardsAcked);
        builder.startObject(CONDITIONS);
        for (Map.Entry entry : conditionStatus) {
            builder.field(entry.getKey(), entry.getValue());
        }
        builder.endObject();
        builder.endObject();
        return builder;
    }
}