org.elasticsearch.cluster.metadata.DataStreamAction Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
There is a newer version: 8.13.4
/*
 * 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.cluster.metadata;

import org.elasticsearch.common.Strings;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.io.stream.Writeable;
import org.elasticsearch.xcontent.ConstructingObjectParser;
import org.elasticsearch.xcontent.ObjectParser;
import org.elasticsearch.xcontent.ParseField;
import org.elasticsearch.xcontent.ToXContentObject;
import org.elasticsearch.xcontent.XContentBuilder;
import org.elasticsearch.xcontent.XContentParser;

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

import static org.elasticsearch.xcontent.ConstructingObjectParser.optionalConstructorArg;

/**
 * Operations on data streams. Currently supports adding and removing backing indices.
 */
public class DataStreamAction implements Writeable, ToXContentObject {

    private static final ParseField DATA_STREAM = new ParseField("data_stream");
    private static final ParseField INDEX = new ParseField("index");

    private static final ParseField ADD_BACKING_INDEX = new ParseField("add_backing_index");
    private static final ParseField REMOVE_BACKING_INDEX = new ParseField("remove_backing_index");

    public enum Type {
        ADD_BACKING_INDEX((byte) 0, DataStreamAction.ADD_BACKING_INDEX),
        REMOVE_BACKING_INDEX((byte) 1, DataStreamAction.REMOVE_BACKING_INDEX);

        private final byte value;
        private final String fieldName;

        Type(byte value, ParseField field) {
            this.value = value;
            this.fieldName = field.getPreferredName();
        }

        public byte value() {
            return value;
        }

        public static Type fromValue(byte value) {
            return switch (value) {
                case 0 -> ADD_BACKING_INDEX;
                case 1 -> REMOVE_BACKING_INDEX;
                default -> throw new IllegalArgumentException("no data stream action type for [" + value + "]");
            };
        }
    }

    private final Type type;
    private String dataStream;
    private String index;

    public static DataStreamAction addBackingIndex(String dataStream, String index) {
        return new DataStreamAction(Type.ADD_BACKING_INDEX, dataStream, index);
    }

    public static DataStreamAction removeBackingIndex(String dataStream, String index) {
        return new DataStreamAction(Type.REMOVE_BACKING_INDEX, dataStream, index);
    }

    public DataStreamAction(StreamInput in) throws IOException {
        this.type = Type.fromValue(in.readByte());
        this.dataStream = in.readString();
        this.index = in.readString();
    }

    private DataStreamAction(Type type, String dataStream, String index) {
        if (false == Strings.hasText(dataStream)) {
            throw new IllegalArgumentException("[data_stream] is required");
        }
        if (false == Strings.hasText(index)) {
            throw new IllegalArgumentException("[index] is required");
        }
        this.type = Objects.requireNonNull(type, "[type] must not be null");
        this.dataStream = dataStream;
        this.index = index;
    }

    DataStreamAction(Type type) {
        this.type = type;
    }

    public String getDataStream() {
        return dataStream;
    }

    public void setDataStream(String datastream) {
        this.dataStream = datastream;
    }

    public String getIndex() {
        return index;
    }

    public void setIndex(String index) {
        this.index = index;
    }

    public Type getType() {
        return type;
    }

    @Override
    public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
        builder.startObject();
        builder.startObject(type.fieldName);
        builder.field(DATA_STREAM.getPreferredName(), dataStream);
        builder.field(INDEX.getPreferredName(), index);
        builder.endObject();
        builder.endObject();
        return builder;
    }

    @Override
    public void writeTo(StreamOutput out) throws IOException {
        out.writeByte(type.value());
        out.writeString(dataStream);
        out.writeString(index);
    }

    public static DataStreamAction fromXContent(XContentParser parser) throws IOException {
        return PARSER.apply(parser, null);
    }

    private static final ObjectParser ADD_BACKING_INDEX_PARSER = parser(
        ADD_BACKING_INDEX.getPreferredName(),
        () -> new DataStreamAction(Type.ADD_BACKING_INDEX)
    );
    private static final ObjectParser REMOVE_BACKING_INDEX_PARSER = parser(
        REMOVE_BACKING_INDEX.getPreferredName(),
        () -> new DataStreamAction(Type.REMOVE_BACKING_INDEX)
    );
    static {
        ADD_BACKING_INDEX_PARSER.declareField(
            DataStreamAction::setDataStream,
            XContentParser::text,
            DATA_STREAM,
            ObjectParser.ValueType.STRING
        );
        ADD_BACKING_INDEX_PARSER.declareField(DataStreamAction::setIndex, XContentParser::text, INDEX, ObjectParser.ValueType.STRING);
        REMOVE_BACKING_INDEX_PARSER.declareField(
            DataStreamAction::setDataStream,
            XContentParser::text,
            DATA_STREAM,
            ObjectParser.ValueType.STRING
        );
        REMOVE_BACKING_INDEX_PARSER.declareField(DataStreamAction::setIndex, XContentParser::text, INDEX, ObjectParser.ValueType.STRING);
    }

    private static ObjectParser parser(String name, Supplier supplier) {
        ObjectParser parser = new ObjectParser<>(name, supplier);
        return parser;
    }

    public static final ConstructingObjectParser PARSER = new ConstructingObjectParser<>(
        "data_stream_action",
        a -> {
            // Take the first action and error if there is more than one action
            DataStreamAction action = null;
            for (Object o : a) {
                if (o != null) {
                    if (action == null) {
                        action = (DataStreamAction) o;
                    } else {
                        throw new IllegalArgumentException("too many data stream operations declared on operation entry");
                    }
                }
            }
            return action;
        }
    );
    static {
        PARSER.declareObject(optionalConstructorArg(), ADD_BACKING_INDEX_PARSER, ADD_BACKING_INDEX);
        PARSER.declareObject(optionalConstructorArg(), REMOVE_BACKING_INDEX_PARSER, REMOVE_BACKING_INDEX);
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null || obj.getClass() != getClass()) {
            return false;
        }
        DataStreamAction other = (DataStreamAction) obj;
        return Objects.equals(type, other.type) && Objects.equals(dataStream, other.dataStream) && Objects.equals(index, other.index);
    }

    @Override
    public int hashCode() {
        return Objects.hash(type, dataStream, index);
    }

}