Package org.elasticsearch.common.settings

Class IndexScopedSettings

java.lang.Object

org.elasticsearch.common.settings.AbstractScopedSettings

org.elasticsearch.common.settings.IndexScopedSettings

public final class IndexScopedSettings
extends AbstractScopedSettings

Encapsulates all valid index level settings.

See Also:

• Setting.Property.IndexScope

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.common.settings.AbstractScopedSettings

AbstractScopedSettings.SettingUpdater<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<Setting<?>>	BUILT_IN_INDEX_SETTINGS
static final IndexScopedSettings	DEFAULT_SCOPED_SETTINGS

Fields inherited from class org.elasticsearch.common.settings.AbstractScopedSettings

ARCHIVED_SETTINGS_PREFIX

Constructor Summary

Constructors

Constructor	Description
IndexScopedSettings(Settings settings, Set<Setting<?>> settingsSet)

Method Summary

Modifier and Type	Method	Description
IndexScopedSettings	copy(Settings settings, IndexMetadata metadata)
boolean	isPrivateSetting(String key)	Returns true iff the setting is a private setting ie.
protected void	validateSettingKey(Setting<?> setting)

Methods inherited from class org.elasticsearch.common.settings.AbstractScopedSettings

addAffixGroupUpdateConsumer, addAffixMapUpdateConsumer, addAffixUpdateConsumer, addAffixUpdateConsumer, addSettingsUpdateConsumer, addSettingsUpdateConsumer, addSettingsUpdateConsumer, addSettingsUpdateConsumer, addSettingsUpdateConsumer, addSettingsUpdateConsumer, applySettings, archiveUnknownOrInvalidSettings, diff, get, get, getScope, isDynamicSetting, isFinalSetting, isValidKey, updateDynamicSettings, updateSettings, upgradeSettings, validate, validate, validate, validate, validateUpdate

Methods inherited from class java.lang.Object

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

Field Details

BUILT_IN_INDEX_SETTINGS

public static final Set<Setting<?>> BUILT_IN_INDEX_SETTINGS

DEFAULT_SCOPED_SETTINGS

public static final IndexScopedSettings DEFAULT_SCOPED_SETTINGS

Constructor Details

IndexScopedSettings

public IndexScopedSettings(Settings settings,
 Set<Setting<?>> settingsSet)

Method Details

copy

public IndexScopedSettings copy(Settings settings,
 IndexMetadata metadata)

validateSettingKey

protected void validateSettingKey(Setting<?> setting)

Overrides:

validateSettingKey in class AbstractScopedSettings

isPrivateSetting

public boolean isPrivateSetting(String key)

Description copied from class: AbstractScopedSettings

Returns true iff the setting is a private setting ie. it should be treated as valid even though it has no internal representation. Otherwise false

Overrides:

isPrivateSetting in class AbstractScopedSettings