Search Results for

    Show / Hide Table of Contents

    Class TermsAggregationDescriptor<T>

    Inheritance
    object
    BucketAggregationDescriptorBase<TermsAggregationDescriptor<T>, ITermsAggregation, T>
    TermsAggregationDescriptor<T>
    Implements
    IDescriptor
    ITermsAggregation
    IBucketAggregation
    IAggregation
    Inherited Members
    BucketAggregationDescriptorBase<TermsAggregationDescriptor<T>, ITermsAggregation, T>.Self
    BucketAggregationDescriptorBase<TermsAggregationDescriptor<T>, ITermsAggregation, T>.Assign<TValue>(TValue, Action<ITermsAggregation, TValue>)
    BucketAggregationDescriptorBase<TermsAggregationDescriptor<T>, ITermsAggregation, T>.Aggregations(Func<AggregationContainerDescriptor<T>, IAggregationContainer>)
    BucketAggregationDescriptorBase<TermsAggregationDescriptor<T>, ITermsAggregation, T>.Aggregations(AggregationDictionary)
    BucketAggregationDescriptorBase<TermsAggregationDescriptor<T>, ITermsAggregation, 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 TermsAggregationDescriptor<T> : BucketAggregationDescriptorBase<TermsAggregationDescriptor<T>, ITermsAggregation, T>, IDescriptor, ITermsAggregation, IBucketAggregation, IAggregation where T : class
    Type Parameters
    Name Description
    T

    Methods

    | Edit this page View Source

    CollectMode(TermsAggregationCollectMode?)

    Declaration
    public TermsAggregationDescriptor<T> CollectMode(TermsAggregationCollectMode? collectMode)
    Parameters
    Type Name Description
    TermsAggregationCollectMode? collectMode
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    Exclude(IEnumerable<string>)

    Declaration
    public TermsAggregationDescriptor<T> Exclude(IEnumerable<string> values)
    Parameters
    Type Name Description
    IEnumerable<string> values
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    Exclude(string)

    Declaration
    public TermsAggregationDescriptor<T> Exclude(string excludePattern)
    Parameters
    Type Name Description
    string excludePattern
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    ExecutionHint(TermsAggregationExecutionHint?)

    Declaration
    public TermsAggregationDescriptor<T> ExecutionHint(TermsAggregationExecutionHint? executionHint)
    Parameters
    Type Name Description
    TermsAggregationExecutionHint? executionHint
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    Field(Field)

    Declaration
    public TermsAggregationDescriptor<T> Field(Field field)
    Parameters
    Type Name Description
    Field field
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    Field<TValue>(Expression<Func<T, TValue>>)

    Declaration
    public TermsAggregationDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> field)
    Parameters
    Type Name Description
    Expression<Func<T, TValue>> field
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    Type Parameters
    Name Description
    TValue
    | Edit this page View Source

    Include(IEnumerable<string>)

    Declaration
    public TermsAggregationDescriptor<T> Include(IEnumerable<string> values)
    Parameters
    Type Name Description
    IEnumerable<string> values
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    Include(long, long)

    Declaration
    public TermsAggregationDescriptor<T> Include(long partition, long numberOfPartitions)
    Parameters
    Type Name Description
    long partition
    long numberOfPartitions
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    Include(string)

    Declaration
    public TermsAggregationDescriptor<T> Include(string includePattern)
    Parameters
    Type Name Description
    string includePattern
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    MinimumDocumentCount(int?)

    Declaration
    public TermsAggregationDescriptor<T> MinimumDocumentCount(int? minimumDocumentCount)
    Parameters
    Type Name Description
    int? minimumDocumentCount
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    Missing(object)

    Declaration
    public TermsAggregationDescriptor<T> Missing(object missing)
    Parameters
    Type Name Description
    object missing
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    Order(Func<TermsOrderDescriptor<T>, IPromise<IList<TermsOrder>>>)

    Declaration
    public TermsAggregationDescriptor<T> Order(Func<TermsOrderDescriptor<T>, IPromise<IList<TermsOrder>>> selector)
    Parameters
    Type Name Description
    Func<TermsOrderDescriptor<T>, IPromise<IList<TermsOrder>>> selector
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    Script(Func<ScriptDescriptor, IScript>)

    Declaration
    public TermsAggregationDescriptor<T> Script(Func<ScriptDescriptor, IScript> scriptSelector)
    Parameters
    Type Name Description
    Func<ScriptDescriptor, IScript> scriptSelector
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    Script(string)

    Declaration
    public TermsAggregationDescriptor<T> Script(string script)
    Parameters
    Type Name Description
    string script
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    ShardSize(int?)

    Declaration
    public TermsAggregationDescriptor<T> ShardSize(int? shardSize)
    Parameters
    Type Name Description
    int? shardSize
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    ShowTermDocCountError(bool?)

    Declaration
    public TermsAggregationDescriptor<T> ShowTermDocCountError(bool? showTermDocCountError = true)
    Parameters
    Type Name Description
    bool? showTermDocCountError
    Returns
    Type Description
    TermsAggregationDescriptor<T>
    | Edit this page View Source

    Size(int?)

    Declaration
    public TermsAggregationDescriptor<T> Size(int? size)
    Parameters
    Type Name Description
    int? size
    Returns
    Type Description
    TermsAggregationDescriptor<T>

    Implements

    IDescriptor
    ITermsAggregation
    IBucketAggregation
    IAggregation

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • CollectMode(TermsAggregationCollectMode?)
      • Exclude(IEnumerable<string>)
      • Exclude(string)
      • ExecutionHint(TermsAggregationExecutionHint?)
      • Field(Field)
      • Field<TValue>(Expression<Func<T, TValue>>)
      • Include(IEnumerable<string>)
      • Include(long, long)
      • Include(string)
      • MinimumDocumentCount(int?)
      • Missing(object)
      • Order(Func<TermsOrderDescriptor<T>, IPromise<IList<TermsOrder>>>)
      • Script(Func<ScriptDescriptor, IScript>)
      • Script(string)
      • ShardSize(int?)
      • ShowTermDocCountError(bool?)
      • Size(int?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX