Package org.opensearch.client.opensearch._global.search

Class SuggestContainer

java.lang.Object

org.opensearch.client.util.TaggedUnion<SuggestContainer.Tag,java.lang.Object>

org.opensearch.client.opensearch._global.search.SuggestContainer

All Implemented Interfaces:

ToJsonp

public class SuggestContainer
extends TaggedUnion<SuggestContainer.Tag,java.lang.Object>
implements ToJsonp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SuggestContainer.Builder
static class	SuggestContainer.Tag

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<SuggestContainer>	DESERIALIZER

Fields inherited from class org.opensearch.client.util.TaggedUnion

tag, value

Method Summary

Modifier and Type	Method	Description
CompletionSuggester	completion()	Get the completion variant value.
boolean	isCompletion()	Is this SuggestContainer of a completion kind?
boolean	isPhrase()	Is this SuggestContainer of a phrase kind?
boolean	isPrefix()	Is this SuggestContainer of a prefix kind?
boolean	isRegex()	Is this SuggestContainer of a regex kind?
boolean	isTerm()	Is this SuggestContainer of a term kind?
boolean	isText()	Is this SuggestContainer of a text kind?
PhraseSuggester	phrase()	Get the phrase variant value.
java.lang.String	prefix()	Get the prefix variant value.
java.lang.String	regex()	Get the regex variant value.
TermSuggester	term()	Get the term variant value.
java.lang.String	text()	Get the text variant value.
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Methods inherited from class org.opensearch.client.util.TaggedUnion

get, is

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<SuggestContainer> DESERIALIZER

Method Details

isCompletion

public boolean isCompletion()

Is this SuggestContainer of a completion kind?

completion

public CompletionSuggester completion()

Get the completion variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the completion kind.

isPhrase

public boolean isPhrase()

Is this SuggestContainer of a phrase kind?

phrase

public PhraseSuggester phrase()

Get the phrase variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the phrase kind.

isPrefix

public boolean isPrefix()

Is this SuggestContainer of a prefix kind?

prefix

public java.lang.String prefix()

Get the prefix variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the prefix kind.

isRegex

public boolean isRegex()

Is this SuggestContainer of a regex kind?

regex

public java.lang.String regex()

Get the regex variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the regex kind.

isTerm

public boolean isTerm()

Is this SuggestContainer of a term kind?

term

public TermSuggester term()

Get the term variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the term kind.

isText

public boolean isText()

Is this SuggestContainer of a text kind?

text

public java.lang.String text()

Get the text variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the text kind.

toJsonp

public void toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Specified by:

toJsonp in interface ToJsonp