Module org.elasticsearch.server
Package org.elasticsearch.common.settings

Enum Class Setting.Property

java.lang.Object
java.lang.Enum<Setting.Property>
org.elasticsearch.common.settings.Setting.Property
All Implemented Interfaces:
Serializable, Comparable<Setting.Property>, Constable
Enclosing class:
Setting<T>
public static enum Setting.Property extends Enum<Setting.Property>

  • Enum Constant Details

    • Filtered

      public static final Setting.Property Filtered
      should be filtered in some api (mask password/credentials)

    • Dynamic

      public static final Setting.Property Dynamic
      iff this setting can be dynamically updateable

    • OperatorDynamic

      public static final Setting.Property OperatorDynamic
      Operator only Dynamic setting

    • Final

      public static final Setting.Property Final
      mark this setting as final, not updateable even when the context is not dynamic ie. Setting this property on an index scoped setting will fail update when the index is closed

    • Deprecated

      public static final Setting.Property Deprecated
      mark this setting as deprecated (critical level)

    • DeprecatedWarning

      public static final Setting.Property DeprecatedWarning
      mark this setting as deprecated (warning level)

    • NodeScope

      public static final Setting.Property NodeScope
      Node scope

    • Consistent

      public static final Setting.Property Consistent
      Secure setting values equal on all nodes

    • IndexScope

      public static final Setting.Property IndexScope
      Index scope

    • NotCopyableOnResize

      public static final Setting.Property NotCopyableOnResize
      Mark this setting as not copyable during an index resize (shrink or split). This property can only be applied to settings that also have IndexScope.

    • InternalIndex

      public static final Setting.Property InternalIndex
      Indicates an index-level setting that is managed internally. Such a setting can only be added to an index on index creation but can not be updated via the update API.

    • PrivateIndex

      public static final Setting.Property PrivateIndex
      Indicates an index-level setting that is privately managed. Such a setting can not even be set on index creation.

    • IndexSettingDeprecatedInV7AndRemovedInV8

      public static final Setting.Property IndexSettingDeprecatedInV7AndRemovedInV8
      Indicates that this index-level setting was deprecated in Version.V_7_17_0 and is forbidden in indices created from Version.V_8_0_0 onwards.

  • Method Details

    • values

      public static Setting.Property[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Setting.Property valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null