Package org.elasticsearch.common.settings

Enum Setting.Property

java.lang.Object

java.lang.Enum<Setting.Property>

org.elasticsearch.common.settings.Setting.Property

All Implemented Interfaces:

Serializable, Comparable<Setting.Property>

Enclosing class:

Setting<T>

public static enum Setting.Property
extends Enum<Setting.Property>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Consistent	Secure setting values equal on all nodes
Deprecated	mark this setting as deprecated
Dynamic	iff this setting can be dynamically updateable
Filtered	should be filtered in some api (mask password/credentials)
Final	mark this setting as final, not updateable even when the context is not dynamic ie.
IndexScope	Index scope
InternalIndex	Indicates an index-level setting that is managed internally.
NodeScope	Node scope
NotCopyableOnResize	Mark this setting as not copyable during an index resize (shrink or split).
PrivateIndex	Indicates an index-level setting that is privately managed.

Method Summary

Modifier and Type	Method	Description
static Setting.Property	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Setting.Property[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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

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

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.

Method Detail

values

public static Setting.Property[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Setting.Property c : Setting.Property.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Setting.Property valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null