Search Results for

    Show / Hide Table of Contents

    Class DateHistogramAggregationDescriptor<T>

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

    Methods

    | Edit this page View Source

    CalendarInterval(DateMathTime)

    The calendar interval to use when bucketing documents

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

    CalendarInterval(DateInterval?)

    The calendar interval to use when bucketing documents

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

    ExtendedBounds(DateMath, DateMath)

    Extend the bounds of the date histogram beyond the data itself, forcing the aggregation to start building buckets on a specific min and/or max value. Using extended bounds only makes sense when MinimumDocumentCount is 0 as empty buckets will never be returned if it is greater than 0.

    Declaration
    public DateHistogramAggregationDescriptor<T> ExtendedBounds(DateMath min, DateMath max)
    Parameters
    Type Name Description
    DateMath min
    DateMath max
    Returns
    Type Description
    DateHistogramAggregationDescriptor<T>
    | Edit this page View Source

    Field(Field)

    The field to target

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

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

    The field to target

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

    FixedInterval(Time)

    The fixed interval to use when bucketing documents

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

    Format(string)

    Return a formatted date string as the key instead an epoch long

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

    HardBounds(DateMath, DateMath)

    The hard_bounds is a counterpart of extended_bounds and can limit the range of buckets in the histogram. It is particularly useful in the case of open data ranges that can result in a very large number of buckets.

    Declaration
    public DateHistogramAggregationDescriptor<T> HardBounds(DateMath min, DateMath max)
    Parameters
    Type Name Description
    DateMath min
    DateMath max
    Returns
    Type Description
    DateHistogramAggregationDescriptor<T>
    | Edit this page View Source

    MinimumDocumentCount(int?)

    The minimum number of documents that a bucket must contain to be returned in the response. The default is 0 meaning that buckets with no documents will be returned.

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

    Missing(DateTime?)

    Defines how to treat documents that are missing a value. By default, they are ignored, but it is also possible to treat them as if they have a value.

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

    Offset(string)

    Change the start value of each bucket by the specified positive (+) or negative offset (-) duration, such as 1h for an hour, or 1d for a day.

    Declaration
    public DateHistogramAggregationDescriptor<T> Offset(string offset)
    Parameters
    Type Name Description
    string offset
    Returns
    Type Description
    DateHistogramAggregationDescriptor<T>
    | Edit this page View Source

    Order(HistogramOrder)

    Defines an order in which returned buckets are sorted. By default the returned buckets are sorted by their key ascending.

    Declaration
    public DateHistogramAggregationDescriptor<T> Order(HistogramOrder order)
    Parameters
    Type Name Description
    HistogramOrder order
    Returns
    Type Description
    DateHistogramAggregationDescriptor<T>
    | Edit this page View Source

    OrderAscending(string)

    Defines an order in which returned buckets are sorted. By default the returned buckets are sorted by their key ascending.

    Declaration
    public DateHistogramAggregationDescriptor<T> OrderAscending(string key)
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    DateHistogramAggregationDescriptor<T>
    | Edit this page View Source

    OrderDescending(string)

    Defines an order in which returned buckets are sorted. By default the returned buckets are sorted by their key ascending.

    Declaration
    public DateHistogramAggregationDescriptor<T> OrderDescending(string key)
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    DateHistogramAggregationDescriptor<T>
    | Edit this page View Source

    Script(Func<ScriptDescriptor, IScript>)

    A script to execute to provide custom computation

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

    Script(string)

    A script to execute to provide custom computation

    Declaration
    public DateHistogramAggregationDescriptor<T> Script(string script)
    Parameters
    Type Name Description
    string script
    Returns
    Type Description
    DateHistogramAggregationDescriptor<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 DateHistogramAggregationDescriptor<T> TimeZone(string timeZone)
    Parameters
    Type Name Description
    string timeZone
    Returns
    Type Description
    DateHistogramAggregationDescriptor<T>

    Implements

    IDescriptor
    IDateHistogramAggregation
    IBucketAggregation
    IAggregation

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • CalendarInterval(DateMathTime)
      • CalendarInterval(DateInterval?)
      • ExtendedBounds(DateMath, DateMath)
      • Field(Field)
      • Field<TValue>(Expression<Func<T, TValue>>)
      • FixedInterval(Time)
      • Format(string)
      • HardBounds(DateMath, DateMath)
      • MinimumDocumentCount(int?)
      • Missing(DateTime?)
      • Offset(string)
      • Order(HistogramOrder)
      • OrderAscending(string)
      • OrderDescending(string)
      • Script(Func<ScriptDescriptor, IScript>)
      • Script(string)
      • TimeZone(string)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX