Class MultiTermsBucket.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.aggregations.MultiBucketBase.AbstractBuilder<MultiTermsBucket.Builder>
org.opensearch.client.opensearch._types.aggregations.MultiTermsBucket.Builder
- All Implemented Interfaces:
CopyableBuilder<MultiTermsBucket.Builder,,MultiTermsBucket> MutableBuilder<MultiTermsBucket.Builder,,MultiTermsBucket> ObjectBuilder<MultiTermsBucket>
- Enclosing class:
MultiTermsBucket
public static class MultiTermsBucket.Builder
extends MultiBucketBase.AbstractBuilder<MultiTermsBucket.Builder>
implements CopyableBuilder<MultiTermsBucket.Builder,MultiTermsBucket>
Builder for
MultiTermsBucket.-
Field Summary
Fields inherited from class org.opensearch.client.opensearch._types.aggregations.MultiBucketBase.AbstractBuilder
aggregations -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aMultiTermsBucket.copy()Create a new builderCopyableBuilderthat is a copy of this one.final MultiTermsBucket.BuilderdocCountErrorUpperBound(Long value) API name:doc_count_error_upper_boundfinal MultiTermsBucket.BuilderRequired - API name:keyfinal MultiTermsBucket.Builderkey(List<FieldValue> list) Required - API name:keyfinal MultiTermsBucket.Builderkey(FieldValue value, FieldValue... values) Required - API name:keyfinal MultiTermsBucket.BuilderkeyAsString(String value) API name:key_as_stringprotected MultiTermsBucket.Builderself()Methods inherited from class org.opensearch.client.opensearch._types.aggregations.MultiBucketBase.AbstractBuilder
aggregations, aggregations, aggregations, docCountMethods 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<MultiTermsBucket.Builder,MultiTermsBucket> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classMultiBucketBase.AbstractBuilder<MultiTermsBucket.Builder>
-
docCountErrorUpperBound
API name:doc_count_error_upper_bound -
key
Required - API name:keyAdds all elements of
listtokey. -
key
Required - API name:keyAdds one or more values to
key. -
key
@Nonnull public final MultiTermsBucket.Builder key(Function<FieldValue.Builder, ObjectBuilder<FieldValue>> fn) Required - API name:keyAdds a value to
keyusing a builder lambda. -
keyAsString
API name:key_as_string -
build
Builds aMultiTermsBucket.- Specified by:
buildin interfaceObjectBuilder<MultiTermsBucket>- Throws:
NullPointerException- if some of the required fields are null.
-