Package org.opensearch.example.customsuggester

Class CustomSuggestionBuilder

java.lang.Object

org.opensearch.search.suggest.SuggestionBuilder<CustomSuggestionBuilder>

org.opensearch.example.customsuggester.CustomSuggestionBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment

public class CustomSuggestionBuilder
extends SuggestionBuilder<CustomSuggestionBuilder>

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.common.io.stream.Writeable

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

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.opensearch.core.ParseField	RANDOM_SUFFIX_FIELD
static final String	SUGGESTION_NAME

Fields inherited from class org.opensearch.search.suggest.SuggestionBuilder

analyzer, ANALYZER_FIELD, field, FIELDNAME_FIELD, prefix, PREFIX_FIELD, regex, REGEX_FIELD, shardSize, SHARDSIZE_FIELD, size, SIZE_FIELD, text, TEXT_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CustomSuggestionBuilder(String randomField, String randomSuffix)
CustomSuggestionBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
SuggestionSearchContext.SuggestionContext	build(QueryShardContext context)
protected boolean	doEquals(CustomSuggestionBuilder other)
protected int	doHashCode()
void	doWriteTo(StreamOutput out)
static CustomSuggestionBuilder	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
String	getWriteableName()
protected org.opensearch.core.xcontent.XContentBuilder	innerToXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)

Methods inherited from class org.opensearch.search.suggest.SuggestionBuilder

analyzer, analyzer, equals, field, hashCode, populateCommonFields, prefix, prefix, regex, regex, shardSize, shardSize, size, size, text, text, toXContent, writeTo

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

Field Details

SUGGESTION_NAME

public static final String SUGGESTION_NAME

See Also:

• Constant Field Values

RANDOM_SUFFIX_FIELD

protected static final org.opensearch.core.ParseField RANDOM_SUFFIX_FIELD

Constructor Details

CustomSuggestionBuilder

public CustomSuggestionBuilder(String randomField,
 String randomSuffix)

CustomSuggestionBuilder

public CustomSuggestionBuilder(StreamInput in)
                        throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

public void doWriteTo(StreamOutput out)
               throws IOException

Specified by:

doWriteTo in class SuggestionBuilder<CustomSuggestionBuilder>

Throws:

IOException

innerToXContent

protected org.opensearch.core.xcontent.XContentBuilder innerToXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                                throws IOException

Specified by:

innerToXContent in class SuggestionBuilder<CustomSuggestionBuilder>

Throws:

IOException

getWriteableName

public String getWriteableName()

doEquals

protected boolean doEquals(CustomSuggestionBuilder other)

Specified by:

doEquals in class SuggestionBuilder<CustomSuggestionBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class SuggestionBuilder<CustomSuggestionBuilder>

fromXContent

public static CustomSuggestionBuilder fromXContent(org.opensearch.core.xcontent.XContentParser parser)
                                            throws IOException

Throws:

IOException

build

public SuggestionSearchContext.SuggestionContext build(QueryShardContext context)
                                                throws IOException

Specified by:

build in class SuggestionBuilder<CustomSuggestionBuilder>

Throws:

IOException