Package org.opensearch.common.settings

Class SettingsModule

java.lang.Object

org.opensearch.common.settings.SettingsModule

All Implemented Interfaces:

Module

public class SettingsModule
extends Object
implements Module

A module that binds the provided settings to the Settings interface.

Opensearch.internal:

Constructor Summary

Constructors

Constructor	Description
SettingsModule(Settings settings, List<Setting<?>> additionalSettings, List<String> settingsFilter, Set<SettingUpgrader<?>> settingUpgraders)
SettingsModule(Settings settings, Setting<?>... additionalSettings)

Method Summary

Modifier and Type	Method	Description
void	configure(Binder binder)	Contributes bindings and other configurations for this module to binder.
ClusterSettings	getClusterSettings()
Set<Setting<?>>	getConsistentSettings()
IndexScopedSettings	getIndexScopedSettings()
Settings	getSettings()
SettingsFilter	getSettingsFilter()
boolean	registerDynamicSetting(Setting<?> setting)	Dynamically registers a new Setting at Runtime.

Methods inherited from class java.lang.Object

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

Constructor Details

SettingsModule

public SettingsModule(Settings settings,
 Setting<?>... additionalSettings)

SettingsModule

public SettingsModule(Settings settings,
 List<Setting<?>> additionalSettings,
 List<String> settingsFilter,
 Set<SettingUpgrader<?>> settingUpgraders)

Method Details

configure

public void configure(Binder binder)

Description copied from interface: Module

Contributes bindings and other configurations for this module to binder.

Do not invoke this method directly to install submodules. Instead use Binder.install(Module), which ensures that provider methods are discovered.

Specified by:

configure in interface Module

registerDynamicSetting

public boolean registerDynamicSetting(Setting<?> setting)

Dynamically registers a new Setting at Runtime. This method is mostly used by plugins/extensions to register new settings at runtime. Settings can be of Node Scope or Index Scope.

Parameters:

setting - which is being registered in the cluster.

Returns:

boolean value is set to true when successfully registered, else returns false

getSettings

public Settings getSettings()

getIndexScopedSettings

public IndexScopedSettings getIndexScopedSettings()

getClusterSettings

public ClusterSettings getClusterSettings()

getConsistentSettings

public Set<Setting<?>> getConsistentSettings()

getSettingsFilter

public SettingsFilter getSettingsFilter()