org.elasticsearch.search.aggregations.bucket.geogrid

Class GeoHashGridBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.AggregationBuilder<GeoHashGridBuilder>

org.elasticsearch.search.aggregations.bucket.geogrid.GeoHashGridBuilder

All Implemented Interfaces:

ToXContent

public class GeoHashGridBuilder
extends AggregationBuilder<GeoHashGridBuilder>

Creates an aggregation based on bucketing points into GeoHashes

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

type

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
GeoHashGridBuilder(String name) Sole constructor.

Method Summary

Modifier and Type	Method and Description
GeoHashGridBuilder	field(String field) Set the field to use to get geo points.
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
GeoHashGridBuilder	precision(int precision) Set the geohash precision to use for this aggregation.
GeoHashGridBuilder	shardSize(int shardSize) Expert: Set the number of buckets to get on each shard to improve accuracy.
GeoHashGridBuilder	size(int requiredSize) Set the number of buckets to return.

Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

setMetaData, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, toXContent

Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeoHashGridBuilder

public GeoHashGridBuilder(String name)

Sole constructor.

Method Detail

field

public GeoHashGridBuilder field(String field)

Set the field to use to get geo points.

precision

public GeoHashGridBuilder precision(int precision)

Set the geohash precision to use for this aggregation. The higher the precision, the more fine-grained this aggregation will be.

size

public GeoHashGridBuilder size(int requiredSize)

Set the number of buckets to return.

shardSize

public GeoHashGridBuilder shardSize(int shardSize)

Expert: Set the number of buckets to get on each shard to improve accuracy.

internalXContent

protected XContentBuilder internalXContent(XContentBuilder builder,
                                           ToXContent.Params params)
                                    throws IOException

Specified by:

internalXContent in class AggregationBuilder<GeoHashGridBuilder>

Throws:

IOException