Module org.elasticsearch.server

Package org.elasticsearch.index

Class IndexMode.IndexModeSettingsProvider

java.lang.Object

org.elasticsearch.index.IndexMode.IndexModeSettingsProvider

All Implemented Interfaces:

IndexSettingProvider

Enclosing class:

IndexMode

public static final class IndexMode.IndexModeSettingsProvider
extends Object
implements IndexSettingProvider

A built-in index setting provider that supplies additional index settings based on the index mode. Currently, only the lookup index mode provides non-empty additional settings.

Nested Class Summary

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

IndexSettingProvider.Parameters

Constructor Summary

Constructors

Constructor	Description
IndexModeSettingsProvider()

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

Methods inherited from interface org.elasticsearch.index.IndexSettingProvider

overrulesTemplateAndRequestSettings

Constructor Details

IndexModeSettingsProvider

public IndexModeSettingsProvider()

Method Details

getAdditionalIndexSettings

public Settings getAdditionalIndexSettings(String indexName,
 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