Class DateHistogramCompositeAggregationSource

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
CompositeAggregationSourceBase
DateHistogramCompositeAggregationSource
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class DateHistogramCompositeAggregationSource : CompositeAggregationSourceBase, IDateHistogramCompositeAggregationSource, ICompositeAggregationSource

Constructors

| Edit this page View Source

DateHistogramCompositeAggregationSource(string)

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

Properties

| Edit this page View Source

CalendarInterval

The calendar interval to use when bucketing documents

Declaration
public 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
public 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
public string Format { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SourceType

The type of the source

Declaration
protected override string SourceType { get; }
Property Value
Type Description
string
Overrides
| 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
public string TimeZone { get; set; }
Property Value
Type Description
string

Implements

Extension Methods