Class CompositeAggregation.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<CompositeAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<CompositeAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.CompositeAggregation.Builder
- All Implemented Interfaces:
CopyableBuilder<CompositeAggregation.Builder,,CompositeAggregation> MutableBuilder<CompositeAggregation.Builder,,CompositeAggregation> ObjectBuilder<CompositeAggregation>
- Enclosing class:
CompositeAggregation
public static class CompositeAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<CompositeAggregation.Builder>
implements CopyableBuilder<CompositeAggregation.Builder,CompositeAggregation>
Builder for
CompositeAggregation.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionafter(String key, Function<FieldValue.Builder, ObjectBuilder<FieldValue>> fn) API name:afterafter(String key, FieldValue value) API name:afterafter(Map<String, FieldValue> map) API name:afterbuild()Builds aCompositeAggregation.copy()Create a new builderCopyableBuilderthat is a copy of this one.protected CompositeAggregation.Builderself()The number of composite buckets that should be returned.sources(List<Map<String, CompositeAggregationSource>> list) The value sources used to build composite buckets.sources(Map<String, CompositeAggregationSource> value, Map<String, CompositeAggregationSource>... values) The value sources used to build composite buckets.Methods 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<CompositeAggregation.Builder,CompositeAggregation> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classAggregationBase.AbstractBuilder<CompositeAggregation.Builder>
-
after
API name:afterAdds all elements of
maptoafter. -
after
API name:afterAdds an entry to
after. -
after
@Nonnull public final CompositeAggregation.Builder after(String key, Function<FieldValue.Builder, ObjectBuilder<FieldValue>> fn) API name:afterAdds a value to
afterusing a builder lambda. -
size
The number of composite buckets that should be returned.API name:
size -
sources
@Nonnull public final CompositeAggregation.Builder sources(List<Map<String, CompositeAggregationSource>> list) The value sources used to build composite buckets. Keys are returned in the order of thesourcesdefinition.API name:
sourcesAdds all elements of
listtosources. -
sources
@Nonnull public final CompositeAggregation.Builder sources(Map<String, CompositeAggregationSource> value, Map<String, CompositeAggregationSource>... values) The value sources used to build composite buckets. Keys are returned in the order of thesourcesdefinition.API name:
sourcesAdds one or more values to
sources. -
build
Builds aCompositeAggregation.- Specified by:
buildin interfaceObjectBuilder<CompositeAggregation>- Throws:
NullPointerException- if some of the required fields are null.
-