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

Class FiltersAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregationBase

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<FiltersAggregation.Builder,FiltersAggregation>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class FiltersAggregation
extends BucketAggregationBase
implements AggregationVariant, ToCopyableBuilder<FiltersAggregation.Builder,FiltersAggregation>

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static FiltersAggregation.Builder	builder()
boolean	equals(Object o)
final Buckets<Query>	filters()	API name: filters
int	hashCode()
final Boolean	keyed()	By default, the named filters aggregation returns the buckets as an object.
static FiltersAggregation	of(Function<FiltersAggregation.Builder,ObjectBuilder<FiltersAggregation>> 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	setupFiltersAggregationDeserializer(ObjectDeserializer<FiltersAggregation.Builder> op)
FiltersAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

setupBucketAggregationBaseDeserializer

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

meta, name, serialize, setupAggregationBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant

toAggregation

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<FiltersAggregation> _DESERIALIZER

Json deserializer for FiltersAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

filters

@Nullable
public final Buckets<Query> filters()

API name: filters

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

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

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

toBuilder

@Nonnull
public FiltersAggregation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<FiltersAggregation.Builder,FiltersAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static FiltersAggregation.Builder builder()

setupFiltersAggregationDeserializer

protected static void setupFiltersAggregationDeserializer(ObjectDeserializer<FiltersAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase