Class HistogramAggregation
java.lang.Object
org.opensearch.client.opensearch._types.aggregations.AggregationBase
org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase
org.opensearch.client.opensearch._types.aggregations.HistogramAggregation
- All Implemented Interfaces:
JsonpSerializable,PlainJsonSerializable,AggregationVariant,ToCopyableBuilder<HistogramAggregation.Builder,HistogramAggregation>
@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class HistogramAggregation
extends BucketAggregationBase
implements AggregationVariant, ToCopyableBuilder<HistogramAggregation.Builder,HistogramAggregation>
-
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<HistogramAggregation> Json deserializer forHistogramAggregation -
Method Summary
Modifier and TypeMethodDescriptionAggregationvariant kind.static HistogramAggregation.Builderbuilder()booleanfinal ExtendedBounds<Double> API name:extended_boundsfinal Stringfield()API name:fieldfinal Stringformat()API name:formatfinal ExtendedBounds<Double> API name:hard_boundsinthashCode()final Doubleinterval()The interval for the buckets.final Booleankeyed()Iftrue, returns buckets as a hash instead of an array, keyed by the bucket keys.final IntegerOnly returns buckets that havemin_doc_countnumber of documents.final Doublemissing()The value to apply to documents that do not have a value.static HistogramAggregationfinal Doubleoffset()By default, the bucket keys start with 0 and then continue in even spaced steps ofinterval.final HistogramOrderorder()API name:orderfinal Scriptscript()API name:scriptprotected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidCreate 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 forHistogramAggregation
-
-
Method Details
-
of
public static HistogramAggregation of(Function<HistogramAggregation.Builder, ObjectBuilder<HistogramAggregation>> fn) -
_aggregationKind
Aggregationvariant kind.- Specified by:
_aggregationKindin interfaceAggregationVariant
-
extendedBounds
API name:extended_bounds -
field
API name:field -
format
API name:format -
hardBounds
API name:hard_bounds -
interval
The interval for the buckets. Must be a positive decimal.API name:
interval -
keyed
Iftrue, returns buckets as a hash instead of an array, keyed by the bucket keys.API name:
keyed -
minDocCount
Only returns buckets that havemin_doc_countnumber of documents. By default, the response will fill gaps in the histogram with empty buckets.API name:
min_doc_count -
missing
The value to apply to documents that do not have a value. By default, documents without a value are ignored.API name:
missing -
offset
By default, the bucket keys start with 0 and then continue in even spaced steps ofinterval. The bucket boundaries can be shifted by using theoffsetoption.API name:
offset -
order
API name:order -
script
API name:script -
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<HistogramAggregation.Builder,HistogramAggregation> - Returns:
- a new builder instance.
-
builder
-
setupHistogramAggregationDeserializer
protected static void setupHistogramAggregationDeserializer(ObjectDeserializer<HistogramAggregation.Builder> op) -
hashCode
public int hashCode()- Overrides:
hashCodein classBucketAggregationBase
-
equals
- Overrides:
equalsin classBucketAggregationBase
-