Package org.opensearch.common.settings

package org.opensearch.common.settings

Settings based utility.

Related Packages

Package	Description
org.opensearch.common	Base package for common classes used across the OpenSearch server codebase.

Class	Description
AbstractScopedSettings	A basic setting service that can be used for per-index and per-cluster settings.
AbstractScopedSettings.SettingUpdater<T>	Transactional interface to update settings.
BaseKeyStoreCommand	Base settings class for key store commands.
ClusterSettings	Encapsulates all valid cluster level settings.
ConsistentSettingsService	Used to publish secure setting hashes in the cluster state and to validate those hashes against the local values of those same settings.
FeatureFlagSettings	Encapsulates all valid feature flag level settings.
HasPasswordKeyStoreCommand	KeyStore command that has a password.
IndexScopedSettings	Encapsulates all valid index level settings.
KeyStoreWrapper	A disk based container for sensitive settings in OpenSearch.
NoClassSettingsException	A specific type of SettingsException indicating failure to load a class based on a settings value.
SecureSetting<T>	A secure setting.
SecureSettings	An accessor for settings which are securely stored.
Setting<T>	A setting.
Setting.AffixKey	A key that allows for static pre and suffix.
Setting.AffixSetting<T>	An affix setting
Setting.AffixSettingDependency	Allows an affix setting to declare a dependency on another affix setting.
Setting.ByteSizeValueParser	A writeable parser for bytesizevalue
Setting.DoubleParser	A writeable parser for double
Setting.FloatParser	A writeable parser for float
Setting.GroupKey	Settings Group keys
Setting.IntegerParser	A writeable parser for integer
Setting.Key	Key for the setting
Setting.ListKey	List settings key
Setting.LongParser	A writeable parser for long
Setting.MemorySizeValueParser	A writeable parser for memory size value
Setting.MinMaxTimeValueParser	A writeable parser for time value have min and max value
Setting.MinTimeValueParser	A writeable parser for time value only has min value
Setting.Property	Property of the setting
Setting.RegexValidator	A writeable validator able to check the value of string type custom setting by using regular expression
Setting.SettingDependency	Allows a setting to declare a dependency on another setting being set.
Setting.SimpleKey	A simple key for a setting
Setting.Validator<T>	Represents a validator for a setting.
Settings	An immutable settings implementation.
Settings.Builder	A builder allowing to put different settings and then Settings.Builder.build() an immutable settings implementation.
SettingsException	A generic failure to handle settings.
SettingsFilter	A class that allows to filter settings objects by simple regular expression patterns or full settings keys.
SettingsModule	A module that binds the provided settings to the Settings interface.
SettingUpgrader<T>	Represents the logic to upgrade a setting.
UpgradeKeyStoreCommand	A sub-command for the keystore CLI that enables upgrading the keystore format.
WriteableSetting	Wrapper for Setting with WriteableSetting.writeTo(StreamOutput) implementation dependent on the setting type.
WriteableSetting.SettingType	The Generic Types which this class can serialize.