Class GeoHashGridAggregation

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.

Inheritance

object

AggregationBase

BucketAggregationBase

GeoHashGridAggregation

Implements

IGeoHashGridAggregation

IBucketAggregation

IAggregation

Inherited Members

BucketAggregationBase.Aggregations

AggregationBase.Meta

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class GeoHashGridAggregation : BucketAggregationBase, IGeoHashGridAggregation, IBucketAggregation, IAggregation

Constructors

GeoHashGridAggregation(string)

Declaration

public GeoHashGridAggregation(string name)

Parameters

Type	Name	Description
string	name

Properties

Bounds

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

Declaration

public IBoundingBox Bounds { get; set; }

Property Value

Type	Description
IBoundingBox

Field

The name of the field indexed with geopoints.

Declaration

public Field Field { get; set; }

Property Value

Type	Description
Field

Precision

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

Declaration

public GeoHashPrecision? Precision { get; set; }

Property Value

Type	Description
GeoHashPrecision?

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

public int? ShardSize { get; set; }

Property Value

Type	Description
int?

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

public int? Size { get; set; }

Property Value

Type	Description
int?

Implements

IGeoHashGridAggregation

IBucketAggregation

IAggregation

Extension Methods

SuffixExtensions.Suffix(object, string)