Class RareTermsAggregation.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<RareTermsAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<RareTermsAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.RareTermsAggregation.Builder
- All Implemented Interfaces:
CopyableBuilder<RareTermsAggregation.Builder,,RareTermsAggregation> MutableBuilder<RareTermsAggregation.Builder,,RareTermsAggregation> ObjectBuilder<RareTermsAggregation>
- Enclosing class:
RareTermsAggregation
public static class RareTermsAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<RareTermsAggregation.Builder>
implements CopyableBuilder<RareTermsAggregation.Builder,RareTermsAggregation>
Builder for
RareTermsAggregation.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aRareTermsAggregation.copy()Create a new builderCopyableBuilderthat is a copy of this one.API name:excludeexclude(TermsExclude value) API name:excludeAPI name:fieldAPI name:includeinclude(TermsInclude value) API name:includemaxDocCount(Long value) The maximum number of documents a term should appear in.API name:missingmissing(FieldValue value) API name:missingThe precision of the internal CuckooFilters.protected RareTermsAggregation.Builderself()API name:value_typeMethods 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<RareTermsAggregation.Builder,RareTermsAggregation> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classAggregationBase.AbstractBuilder<RareTermsAggregation.Builder>
-
exclude
API name:exclude -
exclude
@Nonnull public final RareTermsAggregation.Builder exclude(Function<TermsExclude.Builder, ObjectBuilder<TermsExclude>> fn) API name:exclude -
field
API name:field -
include
API name:include -
include
@Nonnull public final RareTermsAggregation.Builder include(Function<TermsInclude.Builder, ObjectBuilder<TermsInclude>> fn) API name:include -
maxDocCount
The maximum number of documents a term should appear in.API name:
max_doc_count -
missing
API name:missing -
missing
@Nonnull public final RareTermsAggregation.Builder missing(Function<FieldValue.Builder, ObjectBuilder<FieldValue>> fn) API name:missing -
precision
The precision of the internal CuckooFilters. Smaller precision leads to better approximation, but higher memory usage.API name:
precision -
valueType
API name:value_type -
build
Builds aRareTermsAggregation.- Specified by:
buildin interfaceObjectBuilder<RareTermsAggregation>- Throws:
NullPointerException- if some of the required fields are null.
-