Class DateRangeAggregation.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<DateRangeAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<DateRangeAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.DateRangeAggregation.Builder
- All Implemented Interfaces:
CopyableBuilder<DateRangeAggregation.Builder,,DateRangeAggregation> MutableBuilder<DateRangeAggregation.Builder,,DateRangeAggregation> ObjectBuilder<DateRangeAggregation>
- Enclosing class:
DateRangeAggregation
public static class DateRangeAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<DateRangeAggregation.Builder>
implements CopyableBuilder<DateRangeAggregation.Builder,DateRangeAggregation>
Builder for
DateRangeAggregation.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aDateRangeAggregation.copy()Create a new builderCopyableBuilderthat is a copy of this one.API name:fieldThe date format used to formatfromandtoin the response.Set totrueto associate a unique string key with each bucket and returns the ranges as a hash rather than an array.API name:missingmissing(FieldValue value) API name:missingArray of date ranges.ranges(List<DateRangeExpression> list) Array of date ranges.ranges(DateRangeExpression value, DateRangeExpression... values) Array of date ranges.protected DateRangeAggregation.Builderself()API name:time_zoneMethods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder
meta, meta, nameMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<DateRangeAggregation.Builder,DateRangeAggregation> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classAggregationBase.AbstractBuilder<DateRangeAggregation.Builder>
-
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 -
missing
@Nonnull public final DateRangeAggregation.Builder missing(Function<FieldValue.Builder, ObjectBuilder<FieldValue>> fn) API name:missing -
ranges
Array of date ranges.API name:
rangesAdds all elements of
listtoranges. -
ranges
@Nonnull public final DateRangeAggregation.Builder ranges(DateRangeExpression value, DateRangeExpression... values) Array of date ranges.API name:
rangesAdds one or more values to
ranges. -
ranges
@Nonnull public final DateRangeAggregation.Builder ranges(Function<DateRangeExpression.Builder, ObjectBuilder<DateRangeExpression>> fn) Array of date ranges.API name:
rangesAdds a value to
rangesusing a builder lambda. -
timeZone
API name:time_zone -
build
Builds aDateRangeAggregation.- Specified by:
buildin interfaceObjectBuilder<DateRangeAggregation>- Throws:
NullPointerException- if some of the required fields are null.
-