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

Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IDateHistogramCompositeAggregationSource : ICompositeAggregationSource

Properties

| Edit this page View Source

CalendarInterval

The calendar interval to use when bucketing documents

Declaration
[DataMember(Name = "calendar_interval")]
Union<DateInterval?, DateMathTime> CalendarInterval { get; set; }
Property Value
Type Description
Union<DateInterval?, DateMathTime>
| Edit this page View Source

FixedInterval

The fixed interval to use when bucketing documents

Declaration
[DataMember(Name = "fixed_interval")]
Time FixedInterval { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Format

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

Declaration
[DataMember(Name = "format")]
string Format { get; set; }
Property Value
Type Description
string
| Edit this page View Source

TimeZone

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
[DataMember(Name = "time_zone")]
string TimeZone { get; set; }
Property Value
Type Description
string

Extension Methods