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

Class TermsInclude

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, TaggedUnion<TermsInclude.Kind,Object>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class TermsInclude
extends Object
implements TaggedUnion<TermsInclude.Kind,Object>, PlainJsonSerializable

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<TermsInclude>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final TermsInclude.Kind	_kind()	Get the of the kind of variant held by this object.
static TermsInclude.Builder	builder()
boolean	equals(Object o)
int	hashCode()
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(Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)
TermsPartition	partition()	Get the partition variant value.
String	regexp()	Get the regexp variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
List<String>	terms()	Get the terms variant value.
TermsInclude.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

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

toJsonString

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TermsInclude> _DESERIALIZER

Method Details

_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,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<TermsInclude.Kind,Object>

of

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

isPartition

public boolean isPartition()

Is this variant instance of kind partition?

partition

public TermsPartition partition()

Get the partition variant value.

Throws:

IllegalStateException - if the current variant is not the partition kind.

isRegexp

public boolean isRegexp()

Is this variant instance of kind regexp?

regexp

public String regexp()

Get the regexp variant value.

Throws:

IllegalStateException - if the current variant is not the regexp kind.

isTerms

public boolean isTerms()

Is this variant instance of kind terms?

terms

public List<String> terms()

Get the terms variant value.

Throws:

IllegalStateException - if the current variant is not the terms kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public TermsInclude.Builder toBuilder()

builder

@Nonnull
public static TermsInclude.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object