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