Package co.elastic.clients.elasticsearch.security.query_api_keys

Class ApiKeyAggregate

java.lang.Object

co.elastic.clients.elasticsearch.security.query_api_keys.ApiKeyAggregate

All Implemented Interfaces:

JsonpSerializable, OpenTaggedUnion<ApiKeyAggregate.Kind,Object>, TaggedUnion<ApiKeyAggregate.Kind,Object>

public class ApiKeyAggregate
extends Object
implements OpenTaggedUnion<ApiKeyAggregate.Kind,Object>, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ExternallyTaggedUnion.TypedKeysDeserializer<ApiKeyAggregate>	_TYPED_KEYS_DESERIALIZER

Constructor Summary

Constructors

Constructor	Description
ApiKeyAggregate(ApiKeyAggregateVariant value)
ApiKeyAggregate(String kind, JsonData value)	Build a custom plugin-defined ApiKeyAggregate, given its kind and some JSON data

Method Summary

Modifier and Type	Method	Description
JsonData	_custom()	Get the custom plugin-defined variant value.
final String	_customKind()	Get the actual kind when _kind() equals ApiKeyAggregate.Kind._Custom (plugin-defined variant).
final Object	_get()
boolean	_isCustom()	Is this a custom ApiKeyAggregate defined by a plugin?
final ApiKeyAggregate.Kind	_kind()	Get the of the kind of variant held by this object.
CardinalityAggregate	cardinality()	Get the cardinality variant value.
CompositeAggregate	composite()	Get the composite variant value.
DateRangeAggregate	dateRange()	Get the date_range variant value.
DoubleTermsAggregate	dterms()	Get the dterms variant value.
FilterAggregate	filter()	Get the filter variant value.
FiltersAggregate	filters()	Get the filters variant value.
boolean	isCardinality()	Is this variant instance of kind cardinality?
boolean	isComposite()	Is this variant instance of kind composite?
boolean	isDateRange()	Is this variant instance of kind date_range?
boolean	isDterms()	Is this variant instance of kind dterms?
boolean	isFilter()	Is this variant instance of kind filter?
boolean	isFilters()	Is this variant instance of kind filters?
boolean	isLterms()	Is this variant instance of kind lterms?
boolean	isMissing()	Is this variant instance of kind missing?
boolean	isMultiTerms()	Is this variant instance of kind multi_terms?
boolean	isRange()	Is this variant instance of kind range?
boolean	isSterms()	Is this variant instance of kind sterms?
boolean	isUmterms()	Is this variant instance of kind umterms?
boolean	isValueCount()	Is this variant instance of kind value_count?
LongTermsAggregate	lterms()	Get the lterms variant value.
MissingAggregate	missing()	Get the missing variant value.
MultiTermsAggregate	multiTerms()	Get the multi_terms variant value.
static ApiKeyAggregate	of(Function<ApiKeyAggregate.Builder,ObjectBuilder<ApiKeyAggregate>> fn)
RangeAggregate	range()	Get the range variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
StringTermsAggregate	sterms()	Get the sterms variant value.
String	toString()
UnmappedTermsAggregate	umterms()	Get the umterms variant value.
ValueCountAggregate	valueCount()	Get the value_count variant value.

Methods inherited from class java.lang.Object

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

Field Details

_TYPED_KEYS_DESERIALIZER

public static final ExternallyTaggedUnion.TypedKeysDeserializer<ApiKeyAggregate> _TYPED_KEYS_DESERIALIZER

Constructor Details

ApiKeyAggregate

public ApiKeyAggregate(ApiKeyAggregateVariant value)

ApiKeyAggregate

public ApiKeyAggregate(String kind,
 JsonData value)

Build a custom plugin-defined ApiKeyAggregate, given its kind and some JSON data

Method Details

_kind

public final ApiKeyAggregate.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<ApiKeyAggregate.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<ApiKeyAggregate.Kind,Object>

of

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

isCardinality

public boolean isCardinality()

Is this variant instance of kind cardinality?

cardinality

public CardinalityAggregate cardinality()

Get the cardinality variant value.

Throws:

IllegalStateException - if the current variant is not of the cardinality kind.

isComposite

public boolean isComposite()

Is this variant instance of kind composite?

composite

public CompositeAggregate composite()

Get the composite variant value.

Throws:

IllegalStateException - if the current variant is not of the composite kind.

isDateRange

public boolean isDateRange()

Is this variant instance of kind date_range?

dateRange

public DateRangeAggregate dateRange()

Get the date_range variant value.

Throws:

IllegalStateException - if the current variant is not of the date_range kind.

isDterms

public boolean isDterms()

Is this variant instance of kind dterms?

dterms

public DoubleTermsAggregate dterms()

Get the dterms variant value.

Throws:

IllegalStateException - if the current variant is not of the dterms kind.

isFilter

public boolean isFilter()

Is this variant instance of kind filter?

filter

public FilterAggregate filter()

Get the filter variant value.

Throws:

IllegalStateException - if the current variant is not of the filter kind.

isFilters

public boolean isFilters()

Is this variant instance of kind filters?

filters

public FiltersAggregate filters()

Get the filters variant value.

Throws:

IllegalStateException - if the current variant is not of the filters kind.

isLterms

public boolean isLterms()

Is this variant instance of kind lterms?

lterms

public LongTermsAggregate lterms()

Get the lterms variant value.

Throws:

IllegalStateException - if the current variant is not of the lterms kind.

isMissing

public boolean isMissing()

Is this variant instance of kind missing?

missing

public MissingAggregate missing()

Get the missing variant value.

Throws:

IllegalStateException - if the current variant is not of the missing kind.

isMultiTerms

public boolean isMultiTerms()

Is this variant instance of kind multi_terms?

multiTerms

public MultiTermsAggregate multiTerms()

Get the multi_terms variant value.

Throws:

IllegalStateException - if the current variant is not of the multi_terms kind.

isRange

public boolean isRange()

Is this variant instance of kind range?

range

public RangeAggregate range()

Get the range variant value.

Throws:

IllegalStateException - if the current variant is not of the range kind.

isSterms

public boolean isSterms()

Is this variant instance of kind sterms?

sterms

public StringTermsAggregate sterms()

Get the sterms variant value.

Throws:

IllegalStateException - if the current variant is not of the sterms kind.

isUmterms

public boolean isUmterms()

Is this variant instance of kind umterms?

umterms

public UnmappedTermsAggregate umterms()

Get the umterms variant value.

Throws:

IllegalStateException - if the current variant is not of the umterms kind.

isValueCount

public boolean isValueCount()

Is this variant instance of kind value_count?

valueCount

public ValueCountAggregate valueCount()

Get the value_count variant value.

Throws:

IllegalStateException - if the current variant is not of the value_count kind.

_isCustom

public boolean _isCustom()

Is this a custom ApiKeyAggregate defined by a plugin?

_customKind

@Nullable
public final String _customKind()

Get the actual kind when _kind() equals ApiKeyAggregate.Kind._Custom (plugin-defined variant).

Specified by:

_customKind in interface OpenTaggedUnion<ApiKeyAggregate.Kind,Object>

_custom

public JsonData _custom()

Get the custom plugin-defined variant value.

Throws:

IllegalStateException - if the current variant is not ApiKeyAggregate.Kind._Custom.

serialize

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

Specified by:

serialize in interface JsonpSerializable

toString

public String toString()

Overrides:

toString in class Object