Class DateHistogramAggregation
java.lang.Object
org.opensearch.client.opensearch._types.aggregations.AggregationBase
org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase
org.opensearch.client.opensearch._types.aggregations.DateHistogramAggregation
- All Implemented Interfaces:
JsonpSerializable,PlainJsonSerializable,AggregationVariant,ToCopyableBuilder<DateHistogramAggregation.Builder,DateHistogramAggregation>
@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class DateHistogramAggregation
extends BucketAggregationBase
implements AggregationVariant, ToCopyableBuilder<DateHistogramAggregation.Builder,DateHistogramAggregation>
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase
BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<DateHistogramAggregation> Json deserializer forDateHistogramAggregation -
Method Summary
Modifier and TypeMethodDescriptionAggregationvariant kind.builder()final CalendarIntervalAPI name:calendar_intervalbooleanfinal ExtendedBounds<FieldDateMath> API name:extended_boundsfinal Stringfield()API name:fieldfinal TimeAPI name:fixed_intervalfinal Stringformat()The date format used to formatkey_as_stringin the response.final ExtendedBounds<FieldDateMath> API name:hard_boundsinthashCode()final Timeinterval()API name:intervalfinal Booleankeyed()Set totrueto associate a unique string key with each bucket and return the ranges as a hash rather than an array.final IntegerOnly returns buckets that havemin_doc_countnumber of documents.final Stringmissing()API name:missingstatic DateHistogramAggregationfinal Timeoffset()API name:offsetfinal HistogramOrderorder()API name:orderparams()API name:paramsfinal Scriptscript()API name:scriptprotected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidfinal StringtimeZone()API name:time_zoneCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase
setupBucketAggregationBaseDeserializerMethods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase
meta, name, serialize, setupAggregationBaseDeserializerMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant
toAggregationMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forDateHistogramAggregation
-
-
Method Details
-
of
public static DateHistogramAggregation of(Function<DateHistogramAggregation.Builder, ObjectBuilder<DateHistogramAggregation>> fn) -
_aggregationKind
Aggregationvariant kind.- Specified by:
_aggregationKindin interfaceAggregationVariant
-
calendarInterval
API name:calendar_interval -
extendedBounds
API name:extended_bounds -
field
API name:field -
fixedInterval
API name:fixed_interval -
format
The date format used to formatkey_as_stringin the response. If noformatis specified, the first date format specified in the field mapping is used.API name:
format -
hardBounds
API name:hard_bounds -
interval
API name:interval -
keyed
Set totrueto associate a unique string key with each bucket and return the ranges as a hash rather than an array.API name:
keyed -
minDocCount
Only returns buckets that havemin_doc_countnumber of documents. By default, all buckets between the first bucket that matches documents and the last one are returned.API name:
min_doc_count -
missing
API name:missing -
offset
API name:offset -
order
API name:order -
params
API name:params -
script
API name:script -
timeZone
API name:time_zone -
serializeInternal
- Overrides:
serializeInternalin classAggregationBase
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<DateHistogramAggregation.Builder,DateHistogramAggregation> - Returns:
- a new builder instance.
-
builder
-
setupDateHistogramAggregationDeserializer
protected static void setupDateHistogramAggregationDeserializer(ObjectDeserializer<DateHistogramAggregation.Builder> op) -
hashCode
public int hashCode()- Overrides:
hashCodein classBucketAggregationBase
-
equals
- Overrides:
equalsin classBucketAggregationBase
-