Package org.opensearch.client.opensearch._types.aggregations

Class FiltersAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<FiltersAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<FiltersAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.FiltersAggregation.Builder

All Implemented Interfaces:

CopyableBuilder<FiltersAggregation.Builder,FiltersAggregation>, MutableBuilder<FiltersAggregation.Builder,FiltersAggregation>, ObjectBuilder<FiltersAggregation>

Enclosing class:

FiltersAggregation

public static class FiltersAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<FiltersAggregation.Builder>
implements CopyableBuilder<FiltersAggregation.Builder,FiltersAggregation>

Builder for FiltersAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FiltersAggregation	build()	Builds a FiltersAggregation.
FiltersAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final FiltersAggregation.Builder	filters(Function<Buckets.Builder<Query>,ObjectBuilder<Buckets<Query>>> fn)	API name: filters
final FiltersAggregation.Builder	filters(Buckets<Query> value)	API name: filters
final FiltersAggregation.Builder	keyed(Boolean value)	By default, the named filters aggregation returns the buckets as an object.
final FiltersAggregation.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 FiltersAggregation.Builder	otherBucketKey(String value)	The key with which the other bucket is returned.
protected FiltersAggregation.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public FiltersAggregation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<FiltersAggregation.Builder,FiltersAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected FiltersAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<FiltersAggregation.Builder>

filters

@Nonnull
public final FiltersAggregation.Builder filters(@Nullable
 Buckets<Query> value)

API name: filters

filters

@Nonnull
public final FiltersAggregation.Builder filters(Function<Buckets.Builder<Query>,ObjectBuilder<Buckets<Query>>> fn)

API name: filters

keyed

@Nonnull
public final FiltersAggregation.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

otherBucket

@Nonnull
public final FiltersAggregation.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

@Nonnull
public final FiltersAggregation.Builder otherBucketKey(@Nullable
 String value)

The key with which the other bucket is returned.

API name: other_bucket_key

build

@Nonnull
public FiltersAggregation build()

Builds a FiltersAggregation.

Specified by:

build in interface ObjectBuilder<FiltersAggregation>

Throws:

NullPointerException - if some of the required fields are null.