org.elasticsearch.search

Class SearchExtBuilder

java.lang.Object

org.elasticsearch.search.SearchExtBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent

public abstract class SearchExtBuilder
extends java.lang.Object
implements NamedWriteable, ToXContent

Intermediate serializable representation of a search ext section. To be subclassed by plugins that support a custom section as part of a search request, which will be provided within the ext element. Any state needs to be serialized as part of the Writeable.writeTo(StreamOutput) method and read from the incoming stream, usually done adding a constructor that takes StreamInput as an argument. Registration happens through SearchPlugin.getSearchExts(), which also needs a CheckedFunction that's able to parse the incoming request from the REST layer into the proper SearchExtBuilder subclass. NamedWriteable.getWriteableName() must return the same name as the one used for the registration of the SearchPlugin.SearchExtSpec.

See Also:

SearchPlugin.SearchExtSpec

Nested Class Summary

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

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

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SearchExtBuilder()

Method Summary

Modifier and Type	Method and Description
abstract boolean	equals(java.lang.Object obj)
abstract int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

isFragment, toXContent

Constructor Detail

SearchExtBuilder

public SearchExtBuilder()

Method Detail

hashCode

public abstract int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public abstract boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object