Module org.elasticsearch.server

Package org.elasticsearch.cluster.routing.allocation

Class DataTier.DefaultHotAllocationSettingProvider

java.lang.Object

org.elasticsearch.cluster.routing.allocation.DataTier.DefaultHotAllocationSettingProvider

All Implemented Interfaces:

IndexSettingProvider

Enclosing class:

DataTier

public static class DataTier.DefaultHotAllocationSettingProvider
extends Object
implements IndexSettingProvider

This setting provider injects the setting allocating all newly created indices with index.routing.allocation.include._tier_preference: "data_hot" for a data stream index or index.routing.allocation.include._tier_preference: "data_content" for an index not part of a data stream unless the user overrides the setting while the index is being created (in a create index request for instance)

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.index.IndexSettingProvider

IndexSettingProvider.Parameters

Constructor Summary

Constructors

Constructor	Description
DefaultHotAllocationSettingProvider()

Method Summary

Modifier and Type	Method	Description
Settings	getAdditionalIndexSettings(String indexName, String dataStreamName, IndexMode templateIndexMode, Metadata metadata, Instant resolvedAt, Settings indexTemplateAndCreateRequestSettings, List<CompressedXContent> combinedTemplateMappings)	Returns explicitly set default index Settings for the given index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultHotAllocationSettingProvider

public DefaultHotAllocationSettingProvider()

Method Details

getAdditionalIndexSettings

public Settings getAdditionalIndexSettings(String indexName,
 @Nullable
 String dataStreamName,
 IndexMode templateIndexMode,
 Metadata metadata,
 Instant resolvedAt,
 Settings indexTemplateAndCreateRequestSettings,
 List<CompressedXContent> combinedTemplateMappings)

Description copied from interface: IndexSettingProvider

Returns explicitly set default index Settings for the given index. This should not return null.

Specified by:

getAdditionalIndexSettings in interface IndexSettingProvider

Parameters:

indexName - The name of the new index being created

dataStreamName - The name of the data stream if the index being created is part of a data stream otherwise null

templateIndexMode - The index mode defined in template if template creates data streams, otherwise null is returned.

metadata - The current metadata instance that doesn't yet contain the index to be created

resolvedAt - The time the request to create this new index was accepted.

indexTemplateAndCreateRequestSettings - All the settings resolved from the template that matches and any settings defined on the create index request

combinedTemplateMappings - All the mappings resolved from the template that matches