Interface IGeoHashGridAggregation

A multi-bucket aggregation that works on geo_point fields and groups points into buckets that represent cells in a grid. The resulting grid can be sparse and only contains cells that have matching data. Each cell is labeled using a geohash which is of user-definable precision.

Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IGeoHashGridAggregation : IBucketAggregation, IAggregation

Properties

| Edit this page View Source

Bounds

Restricts the points considered to those that fall within the bounds provided.

Declaration
[DataMember(Name = "bounds")]
IBoundingBox Bounds { get; set; }
Property Value
Type Description
IBoundingBox
| Edit this page View Source

Field

The name of the field indexed with geopoints.

Declaration
[DataMember(Name = "field")]
Field Field { get; set; }
Property Value
Type Description
Field
| Edit this page View Source

Precision

The string length of the geohashes used to define cells/buckets in the results. Defaults to Precision5.

Declaration
[DataMember(Name = "precision")]
GeoHashPrecision? Precision { get; set; }
Property Value
Type Description
GeoHashPrecision?
| Edit this page View Source

ShardSize

To allow for more accurate counting of the top cells returned in the final result the aggregation defaults to returning max(10,(size x number-of-shards)) buckets from each shard. If this heuristic is undesirable, the number considered from each shard can be over-ridden using this parameter.

Declaration
[DataMember(Name = "shard_size")]
int? ShardSize { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Size

The maximum number of geohash buckets to return. Defaults to 10,000. When results are trimmed, buckets are prioritised based on the volumes of documents they contain.

Declaration
[DataMember(Name = "size")]
int? Size { get; set; }
Property Value
Type Description
int?

Extension Methods