Package co.elastic.clients.elasticsearch._types.query_dsl

Class PinnedQuery

java.lang.Object

co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

co.elastic.clients.elasticsearch._types.query_dsl.PinnedQuery

All Implemented Interfaces:

QueryVariant, JsonpSerializable, TaggedUnion<java.lang.Object>, UnionVariant

@JsonpDeserializable
public class PinnedQuery
extends QueryBase
implements TaggedUnion<java.lang.Object>, QueryVariant, JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PinnedQuery.Builder

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<PinnedQuery>	_DESERIALIZER
static java.lang.String	DOCS
static java.lang.String	IDS

Constructor Summary

Constructors

Constructor	Description
PinnedQuery(java.util.function.Function<PinnedQuery.Builder,PinnedQuery.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	_get()
java.lang.String	_type()	Get the of the type of the variant held by this union object.
java.lang.String	_variantType()	Query variant type
java.util.List<PinnedDoc>	docs()	Get the docs variant value.
java.util.List<java.lang.String>	ids()	Get the ids variant value.
Query	organic()	Required - API name: organic
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected static void	setupPinnedQueryDeserializer(DelegatingDeserializer<PinnedQuery.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

boost, queryName, serializeInternal, setupQueryBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.query_dsl.QueryVariant

_toQuery

Methods inherited from interface co.elastic.clients.util.TaggedUnion

_is

Field Details

IDS

public static final java.lang.String IDS

See Also:

Constant Field Values

DOCS

public static final java.lang.String DOCS

See Also:

Constant Field Values

_DESERIALIZER

public static final JsonpDeserializer<PinnedQuery> _DESERIALIZER

Constructor Details

PinnedQuery

public PinnedQuery(java.util.function.Function<PinnedQuery.Builder,PinnedQuery.Builder> fn)

Method Details

_variantType

public java.lang.String _variantType()

Query variant type

Specified by:

_variantType in interface UnionVariant

_type

public java.lang.String _type()

Description copied from interface: TaggedUnion

Get the of the type of the variant held by this union object.

Specified by:

_type in interface TaggedUnion<java.lang.Object>

Returns:

the variant type

_get

public java.lang.Object _get()

Specified by:

_get in interface TaggedUnion<java.lang.Object>

organic

public Query organic()

Required - API name: organic

ids

public java.util.List<java.lang.String> ids()

Get the ids variant value.

Throws:

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

docs

public java.util.List<PinnedDoc> docs()

Get the docs variant value.

Throws:

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

serialize

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

Description copied from class: QueryBase

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

Overrides:

serialize in class QueryBase

setupPinnedQueryDeserializer

protected static void setupPinnedQueryDeserializer(DelegatingDeserializer<PinnedQuery.Builder> op)