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

Class BucketsPath

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.BucketsPath

All Implemented Interfaces:

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

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

Buckets path can be expressed in different ways, and an aggregation may accept some or all of these forms depending on its type. Please refer to each aggregation's documentation to know what buckets path forms they accept.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<BucketsPath>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
java.lang.Object	_get()
BucketsPath.Kind	_kind()	Get the of the kind of variant held by this object.
java.util.List<java.lang.String>	array()	Get the array variant value.
java.util.Map<java.lang.String,java.lang.String>	dict()	Get the dict variant value.
boolean	isArray()	Is this variant instance of kind array?
boolean	isDict()	Is this variant instance of kind dict?
boolean	isSingle()	Is this variant instance of kind single?
static BucketsPath	of(java.util.function.Function<BucketsPath.Builder,ObjectBuilder<BucketsPath>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.lang.String	single()	Get the single 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<BucketsPath> _DESERIALIZER

Method Detail

_kind

public final BucketsPath.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

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

Returns:

the variant kind

_get

public final java.lang.Object _get()

Specified by:

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

of

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

isArray

public boolean isArray()

Is this variant instance of kind array?

array

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

Get the array variant value.

Throws:

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

isDict

public boolean isDict()

Is this variant instance of kind dict?

dict

public java.util.Map<java.lang.String,java.lang.String> dict()

Get the dict variant value.

Throws:

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

isSingle

public boolean isSingle()

Is this variant instance of kind single?

single

public java.lang.String single()

Get the single variant value.

Throws:

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

serialize

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

Specified by:

serialize in interface JsonpSerializable