Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.enrich

Class EnrichPolicy

java.lang.Object

org.elasticsearch.xpack.core.enrich.EnrichPolicy

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public final class EnrichPolicy
extends Object
implements Writeable, ToXContentFragment

Represents an enrich policy including its configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EnrichPolicy.NamedPolicy
static class	EnrichPolicy.QuerySource

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENRICH_INDEX_NAME_BASE
static final String	ENRICH_INDEX_PATTERN
static final String	GEO_MATCH_TYPE
static final String	MATCH_TYPE
static final String	RANGE_TYPE
static final String[]	SUPPORTED_POLICY_TYPES

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
EnrichPolicy(String type, EnrichPolicy.QuerySource query, List<String> indices, String matchField, List<String> enrichFields)
EnrichPolicy(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static EnrichPolicy	fromXContent(XContentParser parser)
static String	getBaseName(String policyName)
List<String>	getEnrichFields()
static String	getIndexName(String policyName, long nowTimestamp)	Given a policy name and a timestamp, return the enrich index name that should be used.
List<String>	getIndices()
String	getMatchField()
EnrichPolicy.QuerySource	getQuery()
String	getType()
int	hashCode()
static boolean	isPolicyForIndex(String policyName, String indexName)	Tests whether the named policy is associated with the named index according to the naming pattern that exists between policy names and index names.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

ENRICH_INDEX_NAME_BASE

public static final String ENRICH_INDEX_NAME_BASE

See Also:

• Constant Field Values

ENRICH_INDEX_PATTERN

public static final String ENRICH_INDEX_PATTERN

See Also:

• Constant Field Values

MATCH_TYPE

public static final String MATCH_TYPE

See Also:

• Constant Field Values

GEO_MATCH_TYPE

public static final String GEO_MATCH_TYPE

See Also:

• Constant Field Values

RANGE_TYPE

public static final String RANGE_TYPE

See Also:

• Constant Field Values

SUPPORTED_POLICY_TYPES

public static final String[] SUPPORTED_POLICY_TYPES

Constructor Details

EnrichPolicy

public EnrichPolicy(StreamInput in)
             throws IOException

Throws:

IOException

EnrichPolicy

public EnrichPolicy(String type,
 EnrichPolicy.QuerySource query,
 List<String> indices,
 String matchField,
 List<String> enrichFields)

Method Details

fromXContent

public static EnrichPolicy fromXContent(XContentParser parser)
                                 throws IOException

Throws:

IOException

getType

public String getType()

getQuery

public EnrichPolicy.QuerySource getQuery()

getIndices

public List<String> getIndices()

getMatchField

public String getMatchField()

getEnrichFields

public List<String> getEnrichFields()

getBaseName

public static String getBaseName(String policyName)

getIndexName

public static String getIndexName(String policyName,
 long nowTimestamp)

Given a policy name and a timestamp, return the enrich index name that should be used.

Parameters:

policyName - the name of the policy

nowTimestamp - the current time

Returns:

an enrich index name

isPolicyForIndex

public static boolean isPolicyForIndex(String policyName,
 String indexName)

Tests whether the named policy is associated with the named index according to the naming pattern that exists between policy names and index names.

Parameters:

policyName - the policy name

indexName - the index name

Returns:

true if and only if the named policy is associated with the named index

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object