Class TermsAggregation.Builder
- java.lang.Object
-
- org.opensearch.client.util.ObjectBuilderBase
-
- org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>
-
- org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<TermsAggregation.Builder>
-
- org.opensearch.client.opensearch._types.aggregations.TermsAggregation.Builder
-
- All Implemented Interfaces:
ObjectBuilder<TermsAggregation>
- Enclosing class:
- TermsAggregation
public static class TermsAggregation.Builder extends BucketAggregationBase.AbstractBuilder<TermsAggregation.Builder> implements ObjectBuilder<TermsAggregation>
Builder forTermsAggregation.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TermsAggregationbuild()Builds aTermsAggregation.TermsAggregation.BuildercollectMode(TermsAggregationCollectMode value)API name:collect_modeTermsAggregation.Builderexclude(java.util.function.Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)API name:excludeTermsAggregation.Builderexclude(TermsExclude value)API name:excludeTermsAggregation.BuilderexecutionHint(TermsAggregationExecutionHint value)API name:execution_hintTermsAggregation.Builderfield(java.lang.String value)API name:fieldTermsAggregation.Builderinclude(java.util.function.Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)API name:includeTermsAggregation.Builderinclude(TermsInclude value)API name:includeTermsAggregation.BuilderminDocCount(java.lang.Integer value)API name:min_doc_countTermsAggregation.Buildermissing(java.util.function.Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)API name:missingTermsAggregation.Buildermissing(FieldValue value)API name:missingTermsAggregation.BuildermissingBucket(java.lang.Boolean value)API name:missing_bucketTermsAggregation.BuildermissingOrder(MissingOrder value)API name:missing_orderTermsAggregation.Builderorder(java.util.List<java.util.Map<java.lang.String,SortOrder>> list)API name:orderTermsAggregation.Builderorder(java.util.Map<java.lang.String,SortOrder> value, java.util.Map<java.lang.String,SortOrder>... values)API name:orderTermsAggregation.Builderscript(java.util.function.Function<Script.Builder,ObjectBuilder<Script>> fn)API name:scriptTermsAggregation.Builderscript(Script value)API name:scriptprotected TermsAggregation.Builderself()TermsAggregation.BuildershardSize(java.lang.Integer value)API name:shard_sizeTermsAggregation.BuildershowTermDocCountError(java.lang.Boolean value)API name:show_term_doc_count_errorTermsAggregation.Buildersize(java.lang.Integer value)API name:sizeTermsAggregation.BuildervalueType(java.lang.String value)API name:value_type-
Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder
meta, meta, name
-
Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
-
-
-
Method Detail
-
collectMode
public final TermsAggregation.Builder collectMode(@Nullable TermsAggregationCollectMode value)
API name:collect_mode
-
exclude
public final TermsAggregation.Builder exclude(@Nullable TermsExclude value)
API name:exclude
-
exclude
public final TermsAggregation.Builder exclude(java.util.function.Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)
API name:exclude
-
executionHint
public final TermsAggregation.Builder executionHint(@Nullable TermsAggregationExecutionHint value)
API name:execution_hint
-
field
public final TermsAggregation.Builder field(@Nullable java.lang.String value)
API name:field
-
include
public final TermsAggregation.Builder include(@Nullable TermsInclude value)
API name:include
-
include
public final TermsAggregation.Builder include(java.util.function.Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)
API name:include
-
minDocCount
public final TermsAggregation.Builder minDocCount(@Nullable java.lang.Integer value)
API name:min_doc_count
-
missing
public final TermsAggregation.Builder missing(@Nullable FieldValue value)
API name:missing
-
missing
public final TermsAggregation.Builder missing(java.util.function.Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)
API name:missing
-
missingOrder
public final TermsAggregation.Builder missingOrder(@Nullable MissingOrder value)
API name:missing_order
-
missingBucket
public final TermsAggregation.Builder missingBucket(@Nullable java.lang.Boolean value)
API name:missing_bucket
-
valueType
public final TermsAggregation.Builder valueType(@Nullable java.lang.String value)
API name:value_type
-
order
public final TermsAggregation.Builder order(java.util.List<java.util.Map<java.lang.String,SortOrder>> list)
API name:orderAdds all elements of
listtoorder.
-
order
public final TermsAggregation.Builder order(java.util.Map<java.lang.String,SortOrder> value, java.util.Map<java.lang.String,SortOrder>... values)
API name:orderAdds one or more values to
order.
-
script
public final TermsAggregation.Builder script(@Nullable Script value)
API name:script
-
script
public final TermsAggregation.Builder script(java.util.function.Function<Script.Builder,ObjectBuilder<Script>> fn)
API name:script
-
shardSize
public final TermsAggregation.Builder shardSize(@Nullable java.lang.Integer value)
API name:shard_size
-
showTermDocCountError
public final TermsAggregation.Builder showTermDocCountError(@Nullable java.lang.Boolean value)
API name:show_term_doc_count_error
-
size
public final TermsAggregation.Builder size(@Nullable java.lang.Integer value)
API name:size
-
self
protected TermsAggregation.Builder self()
- Specified by:
selfin classAggregationBase.AbstractBuilder<TermsAggregation.Builder>
-
build
public TermsAggregation build()
Builds aTermsAggregation.- Specified by:
buildin interfaceObjectBuilder<TermsAggregation>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-
-