Class HitsMetadata.Builder<T>
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.core.search.HitsMetadata.Builder<T>
- All Implemented Interfaces:
CopyableBuilder<HitsMetadata.Builder<T>,,HitsMetadata<T>> MutableBuilder<HitsMetadata.Builder<T>,,HitsMetadata<T>> ObjectBuilder<HitsMetadata<T>>
- Enclosing class:
HitsMetadata<T>
public static class HitsMetadata.Builder<T>
extends ObjectBuilderBase
implements CopyableBuilder<HitsMetadata.Builder<T>,HitsMetadata<T>>
Builder for
HitsMetadata.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aHitsMetadata.copy()Create a new builderCopyableBuilderthat is a copy of this one.final HitsMetadata.Builder<T> hits(Function<Hit.Builder<T>, ObjectBuilder<Hit<T>>> fn) Required - API name:hitsfinal HitsMetadata.Builder<T> Required - API name:hitsfinal HitsMetadata.Builder<T> Required - API name:hitsfinal HitsMetadata.Builder<T> API name:max_scorefinal HitsMetadata.Builder<T> The total number of hits, present only iftrack_total_hitsis not set tofalsein the search request.final HitsMetadata.Builder<T> The total number of hits, present only iftrack_total_hitsis not set tofalsein the search request.Methods 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<HitsMetadata.Builder<T>,HitsMetadata<T>> - Returns:
- a new builder instance.
-
hits
Required - API name:hitsAdds all elements of
listtohits. -
hits
Required - API name:hitsAdds one or more values to
hits. -
hits
@Nonnull public final HitsMetadata.Builder<T> hits(Function<Hit.Builder<T>, ObjectBuilder<Hit<T>>> fn) Required - API name:hitsAdds a value to
hitsusing a builder lambda. -
maxScore
API name:max_score -
total
The total number of hits, present only iftrack_total_hitsis not set tofalsein the search request.API name:
total -
total
@Nonnull public final HitsMetadata.Builder<T> total(Function<TotalHits.Builder, ObjectBuilder<TotalHits>> fn) The total number of hits, present only iftrack_total_hitsis not set tofalsein the search request.API name:
total -
build
Builds aHitsMetadata.- Specified by:
buildin interfaceObjectBuilder<T>- Throws:
NullPointerException- if some of the required fields are null.
-