Package org.opensearch.client.json

Class ExternallyTaggedUnion

java.lang.Object

org.opensearch.client.json.ExternallyTaggedUnion

public class ExternallyTaggedUnion
extends Object

Utilities for union types whose discriminant is not directly part of the structure, either as an enclosing property name or as an inner property. This is used for OpenSearch aggregation results and suggesters, using the typed_keys parameter that encodes a name+type in a single JSON property.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExternallyTaggedUnion.Deserializer<Union extends TaggedUnion<?,?>,Member>	A deserializer for externally-tagged unions.
static class	ExternallyTaggedUnion.TypedKeysDeserializer<Union extends TaggedUnion<?,?>>

Method Summary

Modifier and Type	Method	Description
static <T extends TaggedUnion<?, ?>> JsonpDeserializer<Map<String,List<T>>>	arrayDeserializer(ExternallyTaggedUnion.TypedKeysDeserializer<T> deserializer)
static <T extends JsonpSerializable & TaggedUnion<? extends JsonEnum, ?>> void	serializeTypedKeys(Map<String,T> map, jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize an externally tagged union using the typed keys encoding.
static <T extends JsonpSerializable & TaggedUnion<? extends JsonEnum, ?>> void	serializeTypedKeysInner(Map<String,T> map, jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize an externally tagged union using the typed keys encoding, without the enclosing start/end object.

Methods inherited from class java.lang.Object

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

Method Details

arrayDeserializer

public static <T extends TaggedUnion<?,
?>>
JsonpDeserializer<Map<String,List<T>>> arrayDeserializer(ExternallyTaggedUnion.TypedKeysDeserializer<T> deserializer)

serializeTypedKeys

public static <T extends JsonpSerializable & TaggedUnion<? extends JsonEnum,
?>>
void serializeTypedKeys(Map<String,T> map,
 jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize an externally tagged union using the typed keys encoding.

serializeTypedKeysInner

public static <T extends JsonpSerializable & TaggedUnion<? extends JsonEnum,
?>>
void serializeTypedKeysInner(Map<String,T> map,
 jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize an externally tagged union using the typed keys encoding, without the enclosing start/end object.