org.opensearch.action.admin.indices.tiering.TieringUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation

OpenSearch subproject :server

There is a newer version: 2.18.0

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

package org.opensearch.action.admin.indices.tiering;

import org.opensearch.cluster.metadata.IndexMetadata;
import org.opensearch.cluster.routing.ShardRouting;
import org.opensearch.cluster.routing.allocation.RoutingAllocation;
import org.opensearch.index.IndexModule;

/**
 * Utility class for tiering operations
 *
 * @opensearch.internal
 */
public class TieringUtils {

    /**
     *  Checks if the specified shard is a partial shard by
     *  checking the INDEX_STORE_LOCALITY_SETTING for its index.
     *  see {@link #isPartialIndex(IndexMetadata)}
     * @param shard ShardRouting object representing the shard
     * @param allocation RoutingAllocation object representing the allocation
     * @return true if the shard is a partial shard, false otherwise
     */
    public static boolean isPartialShard(ShardRouting shard, RoutingAllocation allocation) {
        IndexMetadata indexMetadata = allocation.metadata().getIndexSafe(shard.index());
        return isPartialIndex(indexMetadata);
    }

    /**
     * Checks if the specified index is a partial index by
     * checking the INDEX_STORE_LOCALITY_SETTING for the index.
     *
     * @param indexMetadata the metadata of the index
     * @return true if the index is a partial index, false otherwise
     */
    public static boolean isPartialIndex(final IndexMetadata indexMetadata) {
        return IndexModule.DataLocalityType.PARTIAL.name()
            .equals(indexMetadata.getSettings().get(IndexModule.INDEX_STORE_LOCALITY_SETTING.getKey()));
    }
}