org.elasticsearch.xpack.core.ml.dataframe.DataFrameAnalyticsState Maven / Gradle / Ivy

/*
 * 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; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */
package org.elasticsearch.xpack.core.ml.dataframe;

import org.elasticsearch.Version;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.io.stream.Writeable;

import java.io.IOException;
import java.util.Arrays;
import java.util.Locale;

public enum DataFrameAnalyticsState implements Writeable {

    // States reindexing and analyzing are no longer used.
    // However, we need to keep them for BWC as tasks may be
    // awaiting assignment in older versioned nodes.
    STARTED, REINDEXING, ANALYZING, STOPPING, STOPPED, FAILED, STARTING;

    public static DataFrameAnalyticsState fromString(String name) {
        return valueOf(name.trim().toUpperCase(Locale.ROOT));
    }

    public static DataFrameAnalyticsState fromStream(StreamInput in) throws IOException {
        return in.readEnum(DataFrameAnalyticsState.class);
    }

    @Override
    public void writeTo(StreamOutput out) throws IOException {
        DataFrameAnalyticsState toWrite = this;
        if (out.getVersion().before(Version.V_7_5_0) && toWrite == STARTING) {
            // Before 7.5.0 there was no STARTING state and jobs for which
            // tasks existed but were unassigned were considered STOPPED
            toWrite = STOPPED;
        }
        out.writeEnum(toWrite);
    }

    @Override
    public String toString() {
        return name().toLowerCase(Locale.ROOT);
    }

    /**
     * @return {@code true} if state matches any of the given {@code candidates}
     */
    public boolean isAnyOf(DataFrameAnalyticsState... candidates) {
        return Arrays.stream(candidates).anyMatch(candidate -> this == candidate);
    }

    /**
     * @return {@code false} if state matches any of the given {@code candidates}
     */
    public boolean isNoneOf(DataFrameAnalyticsState... candidates) {
        return Arrays.stream(candidates).noneMatch(candidate -> this == candidate);
    }
}