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.
  • Constructor Details

    • IndexModeSettingsProvider

      public IndexModeSettingsProvider()
  • Method Details

    • provideAdditionalMetadata

      public void provideAdditionalMetadata(String indexName, String dataStreamName, IndexMode templateIndexMode, ProjectMetadata projectMetadata, Instant resolvedAt, Settings indexTemplateAndCreateRequestSettings, List<CompressedXContent> combinedTemplateMappings, Settings.Builder additionalSettings, BiConsumer<String,Map<String,String>> additionalCustomMetadata)
      Description copied from interface: IndexSettingProvider
      Allows to provide default index Settings and custom index metadata for a newly created index.
      Specified by:
      provideAdditionalMetadata 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.
      projectMetadata - The current project 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
      additionalSettings - A settings builder to which additional settings can be added
      additionalCustomMetadata - A consumer to which additional custom index metadata can be added