Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Interface RoutingFields

All Known Implementing Classes:

RoutingFields.Noop, RoutingPathFields

public interface RoutingFields

Collects fields contributing to routing from documents.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RoutingFields.Noop	Noop implementation that doesn't perform validations on routing fields

Method Summary

Modifier and Type	Method	Description
RoutingFields	addBoolean(String fieldName, boolean value)
RoutingFields	addIp(String fieldName, InetAddress value)
RoutingFields	addLong(String fieldName, long value)
default RoutingFields	addString(String fieldName, String value)
RoutingFields	addString(String fieldName, org.apache.lucene.util.BytesRef utf8Value)	This overloaded method tries to take advantage of the fact that the UTF-8 value is already computed in some cases when we want to collect routing fields, so we can save re-computing the UTF-8 encoding.
RoutingFields	addUnsignedLong(String fieldName, long value)
static RoutingFields	fromIndexSettings(IndexSettings indexSettings)	Collect routing fields from index settings

Method Details

fromIndexSettings

static RoutingFields fromIndexSettings(IndexSettings indexSettings)

Collect routing fields from index settings

addString

RoutingFields addString(String fieldName,
 org.apache.lucene.util.BytesRef utf8Value)

This overloaded method tries to take advantage of the fact that the UTF-8 value is already computed in some cases when we want to collect routing fields, so we can save re-computing the UTF-8 encoding.

addString

default RoutingFields addString(String fieldName,
 String value)

addIp

RoutingFields addIp(String fieldName,
 InetAddress value)

addLong

RoutingFields addLong(String fieldName,
 long value)

addUnsignedLong

RoutingFields addUnsignedLong(String fieldName,
 long value)

addBoolean

RoutingFields addBoolean(String fieldName,
 boolean value)