Search Results for

    Show / Hide Table of Contents

    Class CompositeAggregationSourcesDescriptor<T>

    A values source for ICompositeAggregation

    Inheritance
    object
    DescriptorPromiseBase<CompositeAggregationSourcesDescriptor<T>, IList<ICompositeAggregationSource>>
    CompositeAggregationSourcesDescriptor<T>
    Implements
    IDescriptor
    IPromise<IList<ICompositeAggregationSource>>
    Inherited Members
    DescriptorPromiseBase<CompositeAggregationSourcesDescriptor<T>, IList<ICompositeAggregationSource>>.Self
    DescriptorPromiseBase<CompositeAggregationSourcesDescriptor<T>, IList<ICompositeAggregationSource>>.Assign(Action<IList<ICompositeAggregationSource>>)
    DescriptorPromiseBase<CompositeAggregationSourcesDescriptor<T>, IList<ICompositeAggregationSource>>.Assign<TNewValue>(TNewValue, Action<IList<ICompositeAggregationSource>, TNewValue>)
    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 CompositeAggregationSourcesDescriptor<T> : DescriptorPromiseBase<CompositeAggregationSourcesDescriptor<T>, IList<ICompositeAggregationSource>>, IDescriptor, IPromise<IList<ICompositeAggregationSource>> where T : class
    Type Parameters
    Name Description
    T

    Constructors

    | Edit this page View Source

    CompositeAggregationSourcesDescriptor()

    Declaration
    public CompositeAggregationSourcesDescriptor()

    Methods

    | Edit this page View Source

    DateHistogram(string, Func<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource>)

    A values source that can be applied on date values to build fixed size interval over the values. The interval parameter defines a date/time expression that determines how values should be transformed. For instance an interval set to month will translate any values to its closest month interval..

    Declaration
    public CompositeAggregationSourcesDescriptor<T> DateHistogram(string name, Func<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource> selector)
    Parameters
    Type Name Description
    string name
    Func<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource> selector
    Returns
    Type Description
    CompositeAggregationSourcesDescriptor<T>
    | Edit this page View Source

    GeoTileGrid(string, Func<GeoTileGridCompositeAggregationSourceDescriptor<T>, IGeoTileGridCompositeAggregationSource>)

    A values source that is equivalent to a simple Geo aggregation.

    Declaration
    public CompositeAggregationSourcesDescriptor<T> GeoTileGrid(string name, Func<GeoTileGridCompositeAggregationSourceDescriptor<T>, IGeoTileGridCompositeAggregationSource> selector)
    Parameters
    Type Name Description
    string name
    Func<GeoTileGridCompositeAggregationSourceDescriptor<T>, IGeoTileGridCompositeAggregationSource> selector
    Returns
    Type Description
    CompositeAggregationSourcesDescriptor<T>
    | Edit this page View Source

    Histogram(string, Func<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource>)

    A value source that can be applied on numeric values to build fixed size interval over the values. The interval parameter defines how the numeric values should be transformed. For instance an interval set to 5 will translate any numeric values to its closest interval, a value of 101 would be translated to 100 which is the key for the interval between 100 and 105.

    Declaration
    public CompositeAggregationSourcesDescriptor<T> Histogram(string name, Func<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource> selector)
    Parameters
    Type Name Description
    string name
    Func<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource> selector
    Returns
    Type Description
    CompositeAggregationSourcesDescriptor<T>
    | Edit this page View Source

    Terms(string, Func<TermsCompositeAggregationSourceDescriptor<T>, ITermsCompositeAggregationSource>)

    A values source that is equivalent to a simple terms aggregation. The values are extracted from a field or a script exactly like the terms aggregation.

    Declaration
    public CompositeAggregationSourcesDescriptor<T> Terms(string name, Func<TermsCompositeAggregationSourceDescriptor<T>, ITermsCompositeAggregationSource> selector)
    Parameters
    Type Name Description
    string name
    Func<TermsCompositeAggregationSourceDescriptor<T>, ITermsCompositeAggregationSource> selector
    Returns
    Type Description
    CompositeAggregationSourcesDescriptor<T>

    Implements

    IDescriptor
    IPromise<TValue>

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • CompositeAggregationSourcesDescriptor()
    • Methods
      • DateHistogram(string, Func<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource>)
      • GeoTileGrid(string, Func<GeoTileGridCompositeAggregationSourceDescriptor<T>, IGeoTileGridCompositeAggregationSource>)
      • Histogram(string, Func<HistogramCompositeAggregationSourceDescriptor<T>, IHistogramCompositeAggregationSource>)
      • Terms(string, Func<TermsCompositeAggregationSourceDescriptor<T>, ITermsCompositeAggregationSource>)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX