Class DateRangeAggregation
java.lang.Object
org.opensearch.client.opensearch._types.aggregations.AggregationBase
org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase
org.opensearch.client.opensearch._types.aggregations.DateRangeAggregation
- All Implemented Interfaces:
JsonpSerializable,PlainJsonSerializable,AggregationVariant,ToCopyableBuilder<DateRangeAggregation.Builder,DateRangeAggregation>
@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class DateRangeAggregation
extends BucketAggregationBase
implements AggregationVariant, ToCopyableBuilder<DateRangeAggregation.Builder,DateRangeAggregation>
-
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<DateRangeAggregation> Json deserializer forDateRangeAggregation -
Method Summary
Modifier and TypeMethodDescriptionAggregationvariant kind.static DateRangeAggregation.Builderbuilder()booleanfinal Stringfield()API name:fieldfinal Stringformat()The date format used to formatfromandtoin the response.inthashCode()final Booleankeyed()Set totrueto associate a unique string key with each bucket and returns the ranges as a hash rather than an array.final FieldValuemissing()API name:missingstatic DateRangeAggregationfinal List<DateRangeExpression> ranges()Array of date ranges.protected 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 forDateRangeAggregation
-
-
Method Details
-
of
public static DateRangeAggregation of(Function<DateRangeAggregation.Builder, ObjectBuilder<DateRangeAggregation>> fn) -
_aggregationKind
Aggregationvariant kind.- Specified by:
_aggregationKindin interfaceAggregationVariant
-
field
API name:field -
format
The date format used to formatfromandtoin the response.API name:
format -
keyed
Set totrueto associate a unique string key with each bucket and returns the ranges as a hash rather than an array.API name:
keyed -
missing
API name:missing -
ranges
Array of date ranges.API name:
ranges -
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<DateRangeAggregation.Builder,DateRangeAggregation> - Returns:
- a new builder instance.
-
builder
-
setupDateRangeAggregationDeserializer
protected static void setupDateRangeAggregationDeserializer(ObjectDeserializer<DateRangeAggregation.Builder> op) -
hashCode
public int hashCode()- Overrides:
hashCodein classBucketAggregationBase
-
equals
- Overrides:
equalsin classBucketAggregationBase
-