Package org.opensearch.client.opensearch._types.query_dsl

Class PinnedQuery

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.QueryBase

org.opensearch.client.opensearch._types.query_dsl.PinnedQuery

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, QueryVariant, TaggedUnion<PinnedQuery.Kind,java.lang.Object>

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<PinnedQuery>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
java.lang.Object	_get()
PinnedQuery.Kind	_kind()	Get the of the kind of variant held by this object.
Query.Kind	_queryKind()	Query variant kind.
java.util.List<PinnedDoc>	docs()	Get the docs variant value.
java.util.List<java.lang.String>	ids()	Get the ids variant value.
boolean	isDocs()	Is this variant instance of kind docs?
boolean	isIds()	Is this variant instance of kind ids?
static PinnedQuery	of(java.util.function.Function<PinnedQuery.Builder,ObjectBuilder<PinnedQuery>> fn)
Query	organic()	Required - API name: organic
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected static void	setupPinnedQueryDeserializer(ObjectDeserializer<PinnedQuery.Builder> op)
PinnedQuery.Builder	toBuilder()

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

boost, queryName, serializeInternal, setupQueryBaseDeserializer, toBuilder

Methods inherited from class java.lang.Object

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

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

toJsonString

Methods inherited from interface org.opensearch.client.opensearch._types.query_dsl.QueryVariant

_toQuery, toQuery

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<PinnedQuery> _DESERIALIZER

Method Detail

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

_kind

public final PinnedQuery.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<PinnedQuery.Kind,java.lang.Object>

Returns:

the variant kind

_get

public final java.lang.Object _get()

Specified by:

_get in interface TaggedUnion<PinnedQuery.Kind,java.lang.Object>

of

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

organic

public final Query organic()

Required - API name: organic

isIds

public boolean isIds()

Is this variant instance of kind ids?

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.

isDocs

public boolean isDocs()

Is this variant instance of kind docs?

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

toBuilder

public PinnedQuery.Builder toBuilder()

setupPinnedQueryDeserializer

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