Package org.opensearch.client.opensearch._types.aggregations

Class TermsInclude

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.TermsInclude

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<TermsInclude.Kind,java.lang.Object>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TermsInclude.Builder
static class	TermsInclude.Kind

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<TermsInclude>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
java.lang.Object	_get()
TermsInclude.Kind	_kind()	Get the of the kind of variant held by this object.
boolean	isPartition()	Is this variant instance of kind partition?
boolean	isRegexp()	Is this variant instance of kind regexp?
boolean	isTerms()	Is this variant instance of kind terms?
static TermsInclude	of(java.util.function.Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)
TermsPartition	partition()	Get the partition variant value.
java.lang.String	regexp()	Get the regexp variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.util.List<java.lang.String>	terms()	Get the terms variant value.

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<TermsInclude> _DESERIALIZER

Method Detail

_kind

public final TermsInclude.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

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

Returns:

the variant kind

_get

public final java.lang.Object _get()

Specified by:

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

of

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

isTerms

public boolean isTerms()

Is this variant instance of kind terms?

terms

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

Get the terms variant value.

Throws:

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

isPartition

public boolean isPartition()

Is this variant instance of kind partition?

partition

public TermsPartition partition()

Get the partition variant value.

Throws:

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

isRegexp

public boolean isRegexp()

Is this variant instance of kind regexp?

regexp

public java.lang.String regexp()

Get the regexp variant value.

Throws:

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

serialize

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

Specified by:

serialize in interface JsonpSerializable