Package org.opensearch.common.settings

Class ClusterSettings

java.lang.Object

org.opensearch.common.settings.AbstractScopedSettings

org.opensearch.common.settings.ClusterSettings

@PublicApi(since="1.0.0")
public final class ClusterSettings
extends AbstractScopedSettings

Encapsulates all valid cluster level settings.

Opensearch.api:

Nested Class Summary

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

AbstractScopedSettings.SettingUpdater<T>

Field Summary

Fields

Modifier and Type	Field	Description
static Set<Setting<?>>	BUILT_IN_CLUSTER_SETTINGS
static List<SettingUpgrader<?>>	BUILT_IN_SETTING_UPGRADERS
static final Map<List<String>,List<Setting>>	FEATURE_FLAGGED_CLUSTER_SETTINGS	Map of feature flag name to feature-flagged cluster settings.

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

ARCHIVED_SETTINGS_PREFIX

Constructor Summary

Constructors

Constructor	Description
ClusterSettings(Settings nodeSettings, Set<Setting<?>> settingsSet)
ClusterSettings(Settings nodeSettings, Set<Setting<?>> settingsSet, Set<SettingUpgrader<?>> settingUpgraders)

Method Summary

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

addAffixGroupUpdateConsumer, addAffixMapUpdateConsumer, addAffixUpdateConsumer, addAffixUpdateConsumer, addSettingsUpdateConsumer, addSettingsUpdateConsumer, addSettingsUpdateConsumer, addSettingsUpdateConsumer, addSettingsUpdateConsumer, addSettingsUpdateConsumer, applySettings, archiveUnknownOrInvalidSettings, diff, get, get, getOrNull, getScope, isDynamicSetting, isFinalSetting, isPrivateSetting, isUnmodifiableOnRestoreSetting, isValidKey, registerSetting, unregisterSetting, updateDynamicSettings, updateSettings, upgradeSettings, validate, validate, validate, validate, validateSettingKey, validateUpdate

Methods inherited from class java.lang.Object

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

Field Details

BUILT_IN_CLUSTER_SETTINGS

public static Set<Setting<?>> BUILT_IN_CLUSTER_SETTINGS

BUILT_IN_SETTING_UPGRADERS

public static List<SettingUpgrader<?>> BUILT_IN_SETTING_UPGRADERS

FEATURE_FLAGGED_CLUSTER_SETTINGS

public static final Map<List<String>,List<Setting>> FEATURE_FLAGGED_CLUSTER_SETTINGS

Map of feature flag name to feature-flagged cluster settings. Once each feature is ready for production release, the feature flag can be removed, and the setting should be moved to BUILT_IN_CLUSTER_SETTINGS.

Constructor Details

ClusterSettings

public ClusterSettings(Settings nodeSettings,
 Set<Setting<?>> settingsSet)

ClusterSettings

public ClusterSettings(Settings nodeSettings,
 Set<Setting<?>> settingsSet,
 Set<SettingUpgrader<?>> settingUpgraders)