Module org.elasticsearch.server

Package org.elasticsearch.cluster.routing.allocation

Class DataTier

java.lang.Object

org.elasticsearch.cluster.routing.allocation.DataTier

public class DataTier
extends Object

The DataTier class encapsulates the formalization of the "content", "hot", "warm", and "cold" tiers as node roles. In contains the roles themselves as well as helpers for validation and determining if a node has a tier configured.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataTier.DefaultHotAllocationSettingProvider	This setting provider injects the setting allocating all newly created indices with index.routing.allocation.include._tier_preference: "data_hot" for a data stream index or index.routing.allocation.include._tier_preference: "data_content" for an index not part of a data stream unless the user overrides the setting while the index is being created (in a create index request for instance)

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	ALL_DATA_TIERS
static final String	DATA_COLD
static final String	DATA_CONTENT
static final String	DATA_FROZEN
static final String	DATA_HOT
static final String	DATA_WARM
static final String	ENFORCE_DEFAULT_TIER_PREFERENCE
static final Setting<Boolean>	ENFORCE_DEFAULT_TIER_PREFERENCE_SETTING
static final String	TIER_PREFERENCE
static final Setting<String>	TIER_PREFERENCE_SETTING

Constructor Summary

Constructors

Constructor	Description
DataTier()

Method Summary

Modifier and Type	Method	Description
static int	compare(String tier1, String tier2)	Compares the provided tiers for coldness order (eg.
static String	getPreferredTiersConfiguration(String targetTier)	Based on the provided target tier it will return a comma separated list of preferred tiers.
static Settings	getPreferredTiersConfigurationSettings(String targetTier)
static boolean	isColdNode(DiscoveryNode discoveryNode)
static boolean	isContentNode(DiscoveryNode discoveryNode)
static boolean	isFrozenNode(Set<DiscoveryNodeRole> roles)
static boolean	isFrozenNode(DiscoveryNode discoveryNode)
static boolean	isHotNode(DiscoveryNode discoveryNode)
static boolean	isWarmNode(DiscoveryNode discoveryNode)
static List<String>	parseTierList(String tiers)
static boolean	validTierName(String tierName)	Returns true if the given tier name is a valid tier

Methods inherited from class java.lang.Object

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

Field Details

DATA_CONTENT

public static final String DATA_CONTENT

See Also:

• Constant Field Values

DATA_HOT

public static final String DATA_HOT

See Also:

• Constant Field Values

DATA_WARM

public static final String DATA_WARM

See Also:

• Constant Field Values

DATA_COLD

public static final String DATA_COLD

See Also:

• Constant Field Values

DATA_FROZEN

public static final String DATA_FROZEN

See Also:

• Constant Field Values

ALL_DATA_TIERS

public static final Set<String> ALL_DATA_TIERS

ENFORCE_DEFAULT_TIER_PREFERENCE

public static final String ENFORCE_DEFAULT_TIER_PREFERENCE

See Also:

• Constant Field Values

ENFORCE_DEFAULT_TIER_PREFERENCE_SETTING

public static final Setting<Boolean> ENFORCE_DEFAULT_TIER_PREFERENCE_SETTING

TIER_PREFERENCE

public static final String TIER_PREFERENCE

See Also:

• Constant Field Values

TIER_PREFERENCE_SETTING

public static final Setting<String> TIER_PREFERENCE_SETTING

Constructor Details

DataTier

public DataTier()

Method Details

validTierName

public static boolean validTierName(String tierName)

Returns true if the given tier name is a valid tier

getPreferredTiersConfiguration

public static String getPreferredTiersConfiguration(String targetTier)

Based on the provided target tier it will return a comma separated list of preferred tiers. ie. if `data_cold` is the target tier, it will return `data_cold,data_warm,data_hot`. This is usually used in conjunction with TIER_PREFERENCE_SETTING.

getPreferredTiersConfigurationSettings

public static Settings getPreferredTiersConfigurationSettings(String targetTier)

isContentNode

public static boolean isContentNode(DiscoveryNode discoveryNode)

isHotNode

public static boolean isHotNode(DiscoveryNode discoveryNode)

isWarmNode

public static boolean isWarmNode(DiscoveryNode discoveryNode)

isColdNode

public static boolean isColdNode(DiscoveryNode discoveryNode)

isFrozenNode

public static boolean isFrozenNode(DiscoveryNode discoveryNode)

isFrozenNode

public static boolean isFrozenNode(Set<DiscoveryNodeRole> roles)

parseTierList

public static List<String> parseTierList(String tiers)

compare

public static int compare(String tier1,
 String tier2)

Compares the provided tiers for coldness order (eg. warm is colder than hot). Similar to Comparator.compare(Object, Object) returns -1 if tier1 is colder than tier2 (ie. compare("data_cold", "data_hot")) 0 if tier1 is as cold as tier2 (ie. tier1.equals(tier2) ) 1 if tier1 is warmer than tier2 (ie. compare("data_hot", "data_cold")) The provided tiers parameters must be valid data tiers values (ie. ALL_DATA_TIERS. NOTE: `data_content` is treated as "equal to data_hot" in the tiers hierarchy. If invalid tier names are passed the result is non-deterministic.