Package org.opensearch.client.opensearch.core.search

Class MatchedQueries

java.lang.Object

org.opensearch.client.opensearch.core.search.MatchedQueries

All Implemented Interfaces:

Iterable<String>, Collection<String>, List<String>, SequencedCollection<String>, JsonpSerializable, PlainJsonSerializable, TaggedUnion<MatchedQueries.Kind,Object>

@JsonpDeserializable
public class MatchedQueries
extends Object
implements TaggedUnion<MatchedQueries.Kind,Object>, PlainJsonSerializable, List<String>

The names of queries that matched a hit, with optional per-query scores.

The server returns matched_queries in one of two shapes, and never both: an array of query names when include_named_queries_score is not set, or an object mapping query names to scores when include_named_queries_score is true.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MatchedQueries.Builder
static enum	MatchedQueries.Kind	MatchedQueries variant kinds.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<MatchedQueries>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final MatchedQueries.Kind	_kind()	Get the of the kind of variant held by this object.
void	add(int index, String element)
boolean	add(String e)
boolean	addAll(int index, Collection<? extends String> c)
boolean	addAll(Collection<? extends String> c)
static MatchedQueries.Builder	builder()
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
String	get(int index)
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
boolean	isNames()	Is this variant instance of kind names?
boolean	isScores()	Is this variant instance of kind scores?
Iterator<String>	iterator()
int	lastIndexOf(Object o)
ListIterator<String>	listIterator()
ListIterator<String>	listIterator(int index)
List<String>	names()	Get the names variant value: the names of the queries that matched the hit, returned by the server when include_named_queries_score is not set.
static MatchedQueries	of(Function<MatchedQueries.Builder,ObjectBuilder<MatchedQueries>> fn)
static MatchedQueries	ofNames(List<String> names)
static MatchedQueries	ofScores(Map<String,Double> scores)
String	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
Map<String,Double>	scores()	Get the scores variant value: a map from matched query name to score, returned by the server when include_named_queries_score is true.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
String	set(int index, String element)
int	size()
List<String>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
MatchedQueries.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, getFirst, getLast, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Field Details

_DESERIALIZER

public static final JsonpDeserializer<MatchedQueries> _DESERIALIZER

Method Details

_kind

public final MatchedQueries.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<MatchedQueries.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<MatchedQueries.Kind,Object>

of

public static MatchedQueries of(Function<MatchedQueries.Builder,ObjectBuilder<MatchedQueries>> fn)

ofNames

public static MatchedQueries ofNames(List<String> names)

ofScores

public static MatchedQueries ofScores(Map<String,Double> scores)

isNames

public boolean isNames()

Is this variant instance of kind names?

names

public List<String> names()

Get the names variant value: the names of the queries that matched the hit, returned by the server when include_named_queries_score is not set.

Throws:

IllegalStateException - if the current variant is not the names kind.

isScores

public boolean isScores()

Is this variant instance of kind scores?

scores

public Map<String,Double> scores()

Get the scores variant value: a map from matched query name to score, returned by the server when include_named_queries_score is true.

Throws:

IllegalStateException - if the current variant is not the scores kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public MatchedQueries.Builder toBuilder()

builder

@Nonnull
public static MatchedQueries.Builder builder()

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<String>

Specified by:

hashCode in interface List<String>

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<String>

Specified by:

equals in interface List<String>

Overrides:

equals in class Object

size

public int size()

Specified by:

size in interface Collection<String>

Specified by:

size in interface List<String>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<String>

Specified by:

isEmpty in interface List<String>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<String>

Specified by:

contains in interface List<String>

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Collection<String>

Specified by:

iterator in interface Iterable<String>

Specified by:

iterator in interface List<String>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<String>

Specified by:

toArray in interface List<String>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<String>

Specified by:

toArray in interface List<String>

add

public boolean add(String e)

Specified by:

add in interface Collection<String>

Specified by:

add in interface List<String>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<String>

Specified by:

remove in interface List<String>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<String>

Specified by:

containsAll in interface List<String>

addAll

public boolean addAll(Collection<? extends String> c)

Specified by:

addAll in interface Collection<String>

Specified by:

addAll in interface List<String>

addAll

public boolean addAll(int index,
 Collection<? extends String> c)

Specified by:

addAll in interface List<String>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<String>

Specified by:

removeAll in interface List<String>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<String>

Specified by:

retainAll in interface List<String>

clear

public void clear()

Specified by:

clear in interface Collection<String>

Specified by:

clear in interface List<String>

get

public String get(int index)

Specified by:

get in interface List<String>

set

public String set(int index,
 String element)

Specified by:

set in interface List<String>

add

public void add(int index,
 String element)

Specified by:

add in interface List<String>

remove

public String remove(int index)

Specified by:

remove in interface List<String>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<String>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<String>

listIterator

public ListIterator<String> listIterator()

Specified by:

listIterator in interface List<String>

listIterator

public ListIterator<String> listIterator(int index)

Specified by:

listIterator in interface List<String>

subList

public List<String> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<String>