Package org.opensearch.example.customsuggester

Class CustomSuggestion.Entry.Option

java.lang.Object

org.opensearch.search.suggest.Suggest.Suggestion.Entry.Option

org.opensearch.example.customsuggester.CustomSuggestion.Entry.Option

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment

Enclosing class:

CustomSuggestion.Entry

public static class CustomSuggestion.Entry.Option
extends Suggest.Suggestion.Entry.Option

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V extends Object>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V extends Object>

Field Summary

Fields inherited from class org.opensearch.search.suggest.Suggest.Suggestion.Entry.Option

COLLATE_MATCH, HIGHLIGHTED, SCORE, TEXT

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Option(org.opensearch.core.common.io.stream.StreamInput in)
Option(org.opensearch.core.common.text.Text text, float score, String dummy)

Method Summary

Modifier and Type	Method	Description
static CustomSuggestion.Entry.Option	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
String	getDummy()	A meaningless value used to test that plugin suggesters can add fields to their options
protected void	mergeInto(Suggest.Suggestion.Entry.Option otherOption)
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.search.suggest.Suggest.Suggestion.Entry.Option

collateMatch, equals, getHighlighted, getScore, getText, hashCode, setScore

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Constructor Details

Option

public Option(org.opensearch.core.common.text.Text text,
 float score,
 String dummy)

Option

public Option(org.opensearch.core.common.io.stream.StreamInput in)
       throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class Suggest.Suggestion.Entry.Option

Throws:

IOException

getDummy

public String getDummy()

A meaningless value used to test that plugin suggesters can add fields to their options

mergeInto

protected void mergeInto(Suggest.Suggestion.Entry.Option otherOption)

Overrides:

mergeInto in class Suggest.Suggestion.Entry.Option

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Overrides:

toXContent in class Suggest.Suggestion.Entry.Option

Throws:

IOException

fromXContent

public static CustomSuggestion.Entry.Option fromXContent(org.opensearch.core.xcontent.XContentParser parser)