Class FiltersAggregationDescriptor<T>

Inheritance

object

BucketAggregationDescriptorBase<FiltersAggregationDescriptor<T>, IFiltersAggregation, T>

FiltersAggregationDescriptor<T>

Implements

IDescriptor

IFiltersAggregation

IBucketAggregation

IAggregation

Inherited Members

BucketAggregationDescriptorBase<FiltersAggregationDescriptor<T>, IFiltersAggregation, T>.Self

BucketAggregationDescriptorBase<FiltersAggregationDescriptor<T>, IFiltersAggregation, T>.Assign<TValue>(TValue, Action<IFiltersAggregation, TValue>)

BucketAggregationDescriptorBase<FiltersAggregationDescriptor<T>, IFiltersAggregation, T>.Aggregations(Func<AggregationContainerDescriptor<T>, IAggregationContainer>)

BucketAggregationDescriptorBase<FiltersAggregationDescriptor<T>, IFiltersAggregation, T>.Aggregations(AggregationDictionary)

BucketAggregationDescriptorBase<FiltersAggregationDescriptor<T>, IFiltersAggregation, T>.Meta(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class FiltersAggregationDescriptor<T> : BucketAggregationDescriptorBase<FiltersAggregationDescriptor<T>, IFiltersAggregation, T>, IDescriptor, IFiltersAggregation, IBucketAggregation, IAggregation where T : class

Type Parameters

Name	Description
T

Methods

AnonymousFilters(IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>>)

Declaration

public FiltersAggregationDescriptor<T> AnonymousFilters(IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>> selectors)

Parameters

Type	Name	Description
IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>>	selectors

Returns

Type	Description
FiltersAggregationDescriptor<T>

AnonymousFilters(params Func<QueryContainerDescriptor<T>, QueryContainer>[])

Declaration

public FiltersAggregationDescriptor<T> AnonymousFilters(params Func<QueryContainerDescriptor<T>, QueryContainer>[] selectors)

Parameters

Type	Name	Description
Func<QueryContainerDescriptor<T>, QueryContainer>[]	selectors

Returns

Type	Description
FiltersAggregationDescriptor<T>

NamedFilters(Func<NamedFiltersContainerDescriptor<T>, IPromise<INamedFiltersContainer>>)

Declaration

public FiltersAggregationDescriptor<T> NamedFilters(Func<NamedFiltersContainerDescriptor<T>, IPromise<INamedFiltersContainer>> selector)

Parameters

Type	Name	Description
Func<NamedFiltersContainerDescriptor<T>, IPromise<INamedFiltersContainer>>	selector

Returns

Type	Description
FiltersAggregationDescriptor<T>

OtherBucket(bool?)

Adds a bucket to the response which will contain all documents that do not match any of the given filters. When set to true, the other bucket will be returned either in a bucket (named "other" by default) if named filters are being used, or as the last bucket if anonymous filters are being used When set to false, does not compute the other bucket.

Declaration

public FiltersAggregationDescriptor<T> OtherBucket(bool? otherBucket = true)

Parameters

Type	Name	Description
bool?	otherBucket	whether to set the other bucket

Returns

Type	Description
FiltersAggregationDescriptor<T>	the FiltersAggregationDescriptor<T>

OtherBucketKey(string)

Sets the key for the other bucket to a value other than the default "other". Setting this parameter will implicitly set the OtherBucket(bool?) parameter to true

Declaration

public FiltersAggregationDescriptor<T> OtherBucketKey(string otherBucketKey)

Parameters

Type	Name	Description
string	otherBucketKey	the name for the other bucket

Returns

Type	Description
FiltersAggregationDescriptor<T>	the FiltersAggregationDescriptor<T>

Implements

IDescriptor

IFiltersAggregation

IBucketAggregation

IAggregation

Extension Methods

SuffixExtensions.Suffix(object, string)