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

Class ApiKeyFiltersAggregation

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

co.elastic.clients.elasticsearch.security.query_api_keys.ApiKeyFiltersAggregation

All Implemented Interfaces:

ApiKeyAggregationVariant, JsonpSerializable

@JsonpDeserializable
public class ApiKeyFiltersAggregation
extends BucketAggregationBase
implements ApiKeyAggregationVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApiKeyFiltersAggregation.Builder	Builder for ApiKeyFiltersAggregation.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ApiKeyFiltersAggregation>	_DESERIALIZER	Json deserializer for ApiKeyFiltersAggregation

Method Summary

Modifier and Type	Method	Description
ApiKeyAggregation.Kind	_apiKeyAggregationKind()	ApiKeyAggregation variant kind.
final Buckets<ApiKeyQuery>	filters()	Collection of queries from which to build buckets.
final Boolean	keyed()	By default, the named filters aggregation returns the buckets as an object.
static ApiKeyFiltersAggregation	of(Function<ApiKeyFiltersAggregation.Builder,ObjectBuilder<ApiKeyFiltersAggregation>> fn)
final Boolean	otherBucket()	Set to true to add a bucket to the response which will contain all documents that do not match any of the given filters.
final String	otherBucketKey()	The key with which the other bucket is returned.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupApiKeyFiltersAggregationDeserializer(ObjectDeserializer<ApiKeyFiltersAggregation.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

setupBucketAggregationBaseDeserializer

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase

meta, name, serialize, setupAggregationBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch.security.query_api_keys.ApiKeyAggregationVariant

_toApiKeyAggregation

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ApiKeyFiltersAggregation> _DESERIALIZER

Json deserializer for ApiKeyFiltersAggregation

Method Details

of

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

_apiKeyAggregationKind

public ApiKeyAggregation.Kind _apiKeyAggregationKind()

ApiKeyAggregation variant kind.

Specified by:

_apiKeyAggregationKind in interface ApiKeyAggregationVariant

filters

@Nullable
public final Buckets<ApiKeyQuery> filters()

Collection of queries from which to build buckets.

API name: filters

otherBucket

@Nullable
public final Boolean otherBucket()

Set to true to add a bucket to the response which will contain all documents that do not match any of the given filters.

API name: other_bucket

otherBucketKey

@Nullable
public final String otherBucketKey()

The key with which the other bucket is returned.

API name: other_bucket_key

keyed

@Nullable
public final Boolean keyed()

By default, the named filters aggregation returns the buckets as an object. Set to false to return the buckets as an array of objects.

API name: keyed

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class AggregationBase

setupApiKeyFiltersAggregationDeserializer

protected static void setupApiKeyFiltersAggregationDeserializer(ObjectDeserializer<ApiKeyFiltersAggregation.Builder> op)