Class ApiKeyFiltersAggregation.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder<ApiKeyFiltersAggregation.Builder>
co.elastic.clients.elasticsearch.security.query_api_keys.ApiKeyFiltersAggregation.Builder
- All Implemented Interfaces:
WithJson<ApiKeyFiltersAggregation.Builder>
,ObjectBuilder<ApiKeyFiltersAggregation>
- Enclosing class:
- ApiKeyFiltersAggregation
public static class ApiKeyFiltersAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<ApiKeyFiltersAggregation.Builder>
implements ObjectBuilder<ApiKeyFiltersAggregation>
Builder for
ApiKeyFiltersAggregation
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aApiKeyFiltersAggregation
.filters
(Buckets<ApiKeyQuery> value) Collection of queries from which to build buckets.Collection of queries from which to build buckets.By default, the named filters aggregation returns the buckets as an object.otherBucket
(Boolean value) Set totrue
to add a bucket to the response which will contain all documents that do not match any of the given filters.otherBucketKey
(String value) The key with which the other bucket is returned.protected ApiKeyFiltersAggregation.Builder
self()
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder
meta, meta, name
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
filters
Collection of queries from which to build buckets.API name:
filters
-
filters
public final ApiKeyFiltersAggregation.Builder filters(Function<Buckets.Builder<ApiKeyQuery>, ObjectBuilder<Buckets<ApiKeyQuery>>> fn) Collection of queries from which to build buckets.API name:
filters
-
otherBucket
Set totrue
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
The key with which the other bucket is returned.API name:
other_bucket_key
-
keyed
By default, the named filters aggregation returns the buckets as an object. Set tofalse
to return the buckets as an array of objects.API name:
keyed
-
self
- Specified by:
self
in classAggregationBase.AbstractBuilder<ApiKeyFiltersAggregation.Builder>
-
build
Builds aApiKeyFiltersAggregation
.- Specified by:
build
in interfaceObjectBuilder<ApiKeyFiltersAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-