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

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApiKeyFiltersAggregation	build()	Builds a ApiKeyFiltersAggregation.
final ApiKeyFiltersAggregation.Builder	filters(Buckets<ApiKeyQuery> value)	Collection of queries from which to build buckets.
final ApiKeyFiltersAggregation.Builder	filters(Function<Buckets.Builder<ApiKeyQuery>,ObjectBuilder<Buckets<ApiKeyQuery>>> fn)	Collection of queries from which to build buckets.
final ApiKeyFiltersAggregation.Builder	keyed(Boolean value)	By default, the named filters aggregation returns the buckets as an object.
final ApiKeyFiltersAggregation.Builder	otherBucket(Boolean value)	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 ApiKeyFiltersAggregation.Builder	otherBucketKey(String value)	The key with which the other bucket is returned.
protected ApiKeyFiltersAggregation.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

filters

public final ApiKeyFiltersAggregation.Builder filters(@Nullable
 Buckets<ApiKeyQuery> value)

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

public final ApiKeyFiltersAggregation.Builder otherBucket(@Nullable
 Boolean value)

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

public final ApiKeyFiltersAggregation.Builder otherBucketKey(@Nullable
 String value)

The key with which the other bucket is returned.

API name: other_bucket_key

keyed

public final ApiKeyFiltersAggregation.Builder keyed(@Nullable
 Boolean value)

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

self

protected ApiKeyFiltersAggregation.Builder self()

Specified by:

self in class BucketAggregationBase.AbstractBuilder<ApiKeyFiltersAggregation.Builder>

build

public ApiKeyFiltersAggregation build()

Builds a ApiKeyFiltersAggregation.

Specified by:

build in interface ObjectBuilder<ApiKeyFiltersAggregation>

Throws:

NullPointerException - if some of the required fields are null.