Class TopHitsAggregate.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.aggregations.AggregateBase.AbstractBuilder<TopHitsAggregate.Builder>
org.opensearch.client.opensearch._types.aggregations.TopHitsAggregate.Builder
- All Implemented Interfaces:
CopyableBuilder<TopHitsAggregate.Builder,,TopHitsAggregate> MutableBuilder<TopHitsAggregate.Builder,,TopHitsAggregate> ObjectBuilder<TopHitsAggregate>
- Enclosing class:
TopHitsAggregate
public static class TopHitsAggregate.Builder
extends AggregateBase.AbstractBuilder<TopHitsAggregate.Builder>
implements CopyableBuilder<TopHitsAggregate.Builder,TopHitsAggregate>
Builder for
TopHitsAggregate.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aTopHitsAggregate.copy()Create a new builderCopyableBuilderthat is a copy of this one.final TopHitsAggregate.BuilderRequired - API name:hitsfinal TopHitsAggregate.Builderhits(HitsMetadata<JsonData> value) Required - API name:hitsprotected TopHitsAggregate.Builderself()Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregateBase.AbstractBuilder
meta, metaMethods 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<TopHitsAggregate.Builder,TopHitsAggregate> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classAggregateBase.AbstractBuilder<TopHitsAggregate.Builder>
-
hits
Required - API name:hits -
hits
@Nonnull public final TopHitsAggregate.Builder hits(Function<HitsMetadata.Builder<JsonData>, ObjectBuilder<HitsMetadata<JsonData>>> fn) Required - API name:hits -
build
Builds aTopHitsAggregate.- Specified by:
buildin interfaceObjectBuilder<TopHitsAggregate>- Throws:
NullPointerException- if some of the required fields are null.
-