Class GeoTileGridAggregation.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<GeoTileGridAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<GeoTileGridAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.GeoTileGridAggregation.Builder
- All Implemented Interfaces:
CopyableBuilder<GeoTileGridAggregation.Builder,,GeoTileGridAggregation> MutableBuilder<GeoTileGridAggregation.Builder,,GeoTileGridAggregation> ObjectBuilder<GeoTileGridAggregation>
- Enclosing class:
GeoTileGridAggregation
public static class GeoTileGridAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<GeoTileGridAggregation.Builder>
implements CopyableBuilder<GeoTileGridAggregation.Builder,GeoTileGridAggregation>
Builder for
GeoTileGridAggregation.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAPI name:boundsAPI name:boundsbuild()Builds aGeoTileGridAggregation.copy()Create a new builderCopyableBuilderthat is a copy of this one.API name:fieldAPI name:precisionprotected GeoTileGridAggregation.Builderself()Allows for more accurate counting of the top cells returned in the final result the aggregation.The maximum number of buckets to return.Methods 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<GeoTileGridAggregation.Builder,GeoTileGridAggregation> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classAggregationBase.AbstractBuilder<GeoTileGridAggregation.Builder>
-
bounds
API name:bounds -
bounds
@Nonnull public final GeoTileGridAggregation.Builder bounds(Function<GeoBounds.Builder, ObjectBuilder<GeoBounds>> fn) API name:bounds -
field
API name:field -
precision
API name:precision -
shardSize
Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returningmax(10,(size x number-of-shards))buckets from each shard.API name:
shard_size -
size
The maximum number of buckets to return.API name:
size -
build
Builds aGeoTileGridAggregation.- Specified by:
buildin interfaceObjectBuilder<GeoTileGridAggregation>- Throws:
NullPointerException- if some of the required fields are null.
-