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,Object>
@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class PinnedQuery
extends QueryBase
implements TaggedUnion<PinnedQuery.Kind,Object>, QueryVariant, PlainJsonSerializable
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase
QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>> -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionfinal Object_get()final PinnedQuery.Kind_kind()Get the of the kind of variant held by this object.Queryvariant kind.static PinnedQuery.Builderbuilder()docs()Get thedocsvariant value.booleaninthashCode()ids()Get theidsvariant value.booleanisDocs()Is this variant instance of kinddocs?booleanisIds()Is this variant instance of kindids?static PinnedQueryfinal Queryorganic()Required - API name:organicvoidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected static voidMethods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase
boost, queryName, serializeInternal, setupQueryBaseDeserializerMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.opensearch._types.query_dsl.QueryVariant
toQuery
-
Field Details
-
_DESERIALIZER
-
-
Method Details
-
_queryKind
Queryvariant kind.- Specified by:
_queryKindin interfaceQueryVariant
-
_kind
Description copied from interface:TaggedUnionGet the of the kind of variant held by this object.- Specified by:
_kindin interfaceTaggedUnion<PinnedQuery.Kind,Object> - Returns:
- the variant kind
-
_get
- Specified by:
_getin interfaceTaggedUnion<PinnedQuery.Kind,Object>
-
of
-
organic
Required - API name:organic -
isDocs
public boolean isDocs()Is this variant instance of kinddocs? -
docs
Get thedocsvariant value.- Throws:
IllegalStateException- if the current variant is not thedocskind.
-
isIds
public boolean isIds()Is this variant instance of kindids? -
ids
Get theidsvariant value.- Throws:
IllegalStateException- if the current variant is not theidskind.
-
serialize
Description copied from class:QueryBaseSerialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable- Overrides:
serializein classQueryBase
-
toBuilder
-
builder
-
setupPinnedQueryDeserializer
-
hashCode
public int hashCode() -
equals
-