Package org.elasticsearch.search

Class SearchExtBuilder

java.lang.Object
org.elasticsearch.search.SearchExtBuilder
All Implemented Interfaces:
NamedWriteable, Writeable, ToXContent, ToXContentFragment
public abstract class SearchExtBuilder extends Object implements NamedWriteable, 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. NamedWriteable.getWriteableName() must return the same name as the one used for the registration of the SearchPlugin.SearchExtSpec.
See Also:

  • Constructor Details

    • SearchExtBuilder

      public SearchExtBuilder()

  • Method Details

    • hashCode

      public abstract int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public abstract boolean equals(Object obj)
      Overrides:
      equals in class Object