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

Class ApiKeyAggregation

java.lang.Object

co.elastic.clients.elasticsearch.security.query_api_keys.ApiKeyAggregation

All Implemented Interfaces:

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

@JsonpDeserializable
public class ApiKeyAggregation
extends Object
implements OpenTaggedUnion<ApiKeyAggregation.Kind,Object>, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ApiKeyAggregation(ApiKeyAggregationVariant value)

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 ApiKeyAggregation.Kind._Custom (plugin-defined variant).
final Object	_get()
boolean	_isCustom()	Is this a custom ApiKeyAggregation defined by a plugin?
final ApiKeyAggregation.Kind	_kind()	Get the of the kind of variant held by this object.
final Map<String,ApiKeyAggregation>	aggregations()	Sub-aggregations for this aggregation.
CardinalityAggregation	cardinality()	Get the cardinality variant value.
CompositeAggregation	composite()	Get the composite variant value.
DateRangeAggregation	dateRange()	Get the date_range variant value.
ApiKeyQuery	filter()	Get the filter variant value.
ApiKeyFiltersAggregation	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	isFilter()	Is this variant instance of kind filter?
boolean	isFilters()	Is this variant instance of kind filters?
boolean	isMissing()	Is this variant instance of kind missing?
boolean	isRange()	Is this variant instance of kind range?
boolean	isTerms()	Is this variant instance of kind terms?
boolean	isValueCount()	Is this variant instance of kind value_count?
final Map<String,JsonData>	meta()	API name: meta
MissingAggregation	missing()	Get the missing variant value.
static ApiKeyAggregation	of(Function<ApiKeyAggregation.Builder,ObjectBuilder<ApiKeyAggregation>> fn)
RangeAggregation	range()	Get the range variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupApiKeyAggregationDeserializer(ObjectDeserializer<ApiKeyAggregation.Builder> op)
TermsAggregation	terms()	Get the terms variant value.
String	toString()
ValueCountAggregation	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

_DESERIALIZER

public static final JsonpDeserializer<ApiKeyAggregation> _DESERIALIZER

Constructor Details

ApiKeyAggregation

public ApiKeyAggregation(ApiKeyAggregationVariant value)

Method Details

_kind

public final ApiKeyAggregation.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<ApiKeyAggregation.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<ApiKeyAggregation.Kind,Object>

of

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

aggregations

public final Map<String,ApiKeyAggregation> aggregations()

Sub-aggregations for this aggregation. Only applies to bucket aggregations.

API name: aggregations

meta

public final Map<String,JsonData> meta()

API name: meta

isCardinality

public boolean isCardinality()

Is this variant instance of kind cardinality?

cardinality

public CardinalityAggregation 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 CompositeAggregation 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 DateRangeAggregation dateRange()

Get the date_range variant value.

Throws:

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

isFilter

public boolean isFilter()

Is this variant instance of kind filter?

filter

public ApiKeyQuery 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 ApiKeyFiltersAggregation filters()

Get the filters variant value.

Throws:

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

isMissing

public boolean isMissing()

Is this variant instance of kind missing?

missing

public MissingAggregation missing()

Get the missing variant value.

Throws:

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

isRange

public boolean isRange()

Is this variant instance of kind range?

range

public RangeAggregation range()

Get the range variant value.

Throws:

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

isTerms

public boolean isTerms()

Is this variant instance of kind terms?

terms

public TermsAggregation terms()

Get the terms variant value.

Throws:

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

isValueCount

public boolean isValueCount()

Is this variant instance of kind value_count?

valueCount

public ValueCountAggregation 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 ApiKeyAggregation defined by a plugin?

_customKind

@Nullable
public final String _customKind()

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

Specified by:

_customKind in interface OpenTaggedUnion<ApiKeyAggregation.Kind,Object>

_custom

public JsonData _custom()

Get the custom plugin-defined variant value.

Throws:

IllegalStateException - if the current variant is not ApiKeyAggregation.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

setupApiKeyAggregationDeserializer

protected static void setupApiKeyAggregationDeserializer(ObjectDeserializer<ApiKeyAggregation.Builder> op)