java.lang.Object
org.elasticsearch.search.SearchExtBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,ToXContent,ToXContentFragment
public abstract class SearchExtBuilder
extends Object
implements VersionedNamedWriteable, ToXContentFragment
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.
VersionedNamedWriteable.getWriteableName() must return the same name as the one used for the registration
of the SearchPlugin.SearchExtSpec.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract booleanThe minimal version of the recipient this object can be sent toabstract inthashCode()Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContent
toXContentMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragmentMethods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable
getWriteableName
-
Constructor Details
-
SearchExtBuilder
public SearchExtBuilder()
-
-
Method Details
-
hashCode
public abstract int hashCode() -
equals
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to- Specified by:
getMinimalSupportedVersionin interfaceVersionedNamedWriteable
-