Search Results for

    Show / Hide Table of Contents

    Class DateHistogramCompositeAggregationSourceDescriptor<T>

    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..

    Inheritance
    object
    DescriptorBase<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource>
    CompositeAggregationSourceDescriptorBase<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource, T>
    DateHistogramCompositeAggregationSourceDescriptor<T>
    Implements
    IDescriptor
    IDateHistogramCompositeAggregationSource
    ICompositeAggregationSource
    Inherited Members
    CompositeAggregationSourceDescriptorBase<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource, T>.Field(Field)
    CompositeAggregationSourceDescriptorBase<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource, T>.Field<TValue>(Expression<Func<T, TValue>>)
    CompositeAggregationSourceDescriptorBase<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource, T>.Order(SortOrder?)
    CompositeAggregationSourceDescriptorBase<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource, T>.MissingBucket(bool?)
    DescriptorBase<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource>.Self
    DescriptorBase<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource>.Assign<TValue>(TValue, Action<IDateHistogramCompositeAggregationSource, TValue>)
    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 DateHistogramCompositeAggregationSourceDescriptor<T> : CompositeAggregationSourceDescriptorBase<DateHistogramCompositeAggregationSourceDescriptor<T>, IDateHistogramCompositeAggregationSource, T>, IDescriptor, IDateHistogramCompositeAggregationSource, ICompositeAggregationSource
    Type Parameters
    Name Description
    T

    Constructors

    | Edit this page View Source

    DateHistogramCompositeAggregationSourceDescriptor(string)

    Declaration
    public DateHistogramCompositeAggregationSourceDescriptor(string name)
    Parameters
    Type Name Description
    string name

    Methods

    | Edit this page View Source

    CalendarInterval(DateMathTime)

    The calendar interval to use when bucketing documents

    Declaration
    public DateHistogramCompositeAggregationSourceDescriptor<T> CalendarInterval(DateMathTime interval)
    Parameters
    Type Name Description
    DateMathTime interval
    Returns
    Type Description
    DateHistogramCompositeAggregationSourceDescriptor<T>
    | Edit this page View Source

    CalendarInterval(DateInterval?)

    The calendar interval to use when bucketing documents

    Declaration
    public DateHistogramCompositeAggregationSourceDescriptor<T> CalendarInterval(DateInterval? interval)
    Parameters
    Type Name Description
    DateInterval? interval
    Returns
    Type Description
    DateHistogramCompositeAggregationSourceDescriptor<T>
    | Edit this page View Source

    FixedInterval(Time)

    The fixed interval to use when bucketing documents

    Declaration
    public DateHistogramCompositeAggregationSourceDescriptor<T> FixedInterval(Time interval)
    Parameters
    Type Name Description
    Time interval
    Returns
    Type Description
    DateHistogramCompositeAggregationSourceDescriptor<T>
    | Edit this page View Source

    Format(string)

    Used to indicate that bucketing should use a different time zone. Time zones may either be specified as an ISO 8601 UTC offset (e.g. +01:00 or -08:00) or as a timezone id, an identifier used in the TZ database like America/Los_Angeles.

    Declaration
    public DateHistogramCompositeAggregationSourceDescriptor<T> Format(string format)
    Parameters
    Type Name Description
    string format
    Returns
    Type Description
    DateHistogramCompositeAggregationSourceDescriptor<T>
    | Edit this page View Source

    TimeZone(string)

    Used to indicate that bucketing should use a different time zone. Time zones may either be specified as an ISO 8601 UTC offset (e.g. +01:00 or -08:00) or as a timezone id, an identifier used in the TZ database like America/Los_Angeles.

    Declaration
    public DateHistogramCompositeAggregationSourceDescriptor<T> TimeZone(string timezone)
    Parameters
    Type Name Description
    string timezone
    Returns
    Type Description
    DateHistogramCompositeAggregationSourceDescriptor<T>

    Implements

    IDescriptor
    IDateHistogramCompositeAggregationSource
    ICompositeAggregationSource

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • DateHistogramCompositeAggregationSourceDescriptor(string)
    • Methods
      • CalendarInterval(DateMathTime)
      • CalendarInterval(DateInterval?)
      • FixedInterval(Time)
      • Format(string)
      • TimeZone(string)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX