Search Results for

    Show / Hide Table of Contents

    Class GeoHashGridAggregationDescriptor<T>

    Inheritance
    object
    BucketAggregationDescriptorBase<GeoHashGridAggregationDescriptor<T>, IGeoHashGridAggregation, T>
    GeoHashGridAggregationDescriptor<T>
    Implements
    IDescriptor
    IGeoHashGridAggregation
    IBucketAggregation
    IAggregation
    Inherited Members
    BucketAggregationDescriptorBase<GeoHashGridAggregationDescriptor<T>, IGeoHashGridAggregation, T>.Self
    BucketAggregationDescriptorBase<GeoHashGridAggregationDescriptor<T>, IGeoHashGridAggregation, T>.Assign<TValue>(TValue, Action<IGeoHashGridAggregation, TValue>)
    BucketAggregationDescriptorBase<GeoHashGridAggregationDescriptor<T>, IGeoHashGridAggregation, T>.Aggregations(Func<AggregationContainerDescriptor<T>, IAggregationContainer>)
    BucketAggregationDescriptorBase<GeoHashGridAggregationDescriptor<T>, IGeoHashGridAggregation, T>.Aggregations(AggregationDictionary)
    BucketAggregationDescriptorBase<GeoHashGridAggregationDescriptor<T>, IGeoHashGridAggregation, T>.Meta(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)
    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 GeoHashGridAggregationDescriptor<T> : BucketAggregationDescriptorBase<GeoHashGridAggregationDescriptor<T>, IGeoHashGridAggregation, T>, IDescriptor, IGeoHashGridAggregation, IBucketAggregation, IAggregation where T : class
    Type Parameters
    Name Description
    T

    Methods

    | Edit this page View Source

    Bounds(Func<BoundingBoxDescriptor, IBoundingBox>)

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

    Declaration
    public GeoHashGridAggregationDescriptor<T> Bounds(Func<BoundingBoxDescriptor, IBoundingBox> selector)
    Parameters
    Type Name Description
    Func<BoundingBoxDescriptor, IBoundingBox> selector
    Returns
    Type Description
    GeoHashGridAggregationDescriptor<T>
    | Edit this page View Source

    Field(Field)

    The name of the field indexed with geopoints.

    Declaration
    public GeoHashGridAggregationDescriptor<T> Field(Field field)
    Parameters
    Type Name Description
    Field field
    Returns
    Type Description
    GeoHashGridAggregationDescriptor<T>
    | Edit this page View Source

    Field<TValue>(Expression<Func<T, TValue>>)

    The name of the field indexed with geopoints.

    Declaration
    public GeoHashGridAggregationDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> field)
    Parameters
    Type Name Description
    Expression<Func<T, TValue>> field
    Returns
    Type Description
    GeoHashGridAggregationDescriptor<T>
    Type Parameters
    Name Description
    TValue
    | Edit this page View Source

    GeoHashPrecision(GeoHashPrecision?)

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

    Declaration
    public GeoHashGridAggregationDescriptor<T> GeoHashPrecision(GeoHashPrecision? precision)
    Parameters
    Type Name Description
    GeoHashPrecision? precision
    Returns
    Type Description
    GeoHashGridAggregationDescriptor<T>
    | Edit this page View Source

    ShardSize(int?)

    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 GeoHashGridAggregationDescriptor<T> ShardSize(int? shardSize)
    Parameters
    Type Name Description
    int? shardSize
    Returns
    Type Description
    GeoHashGridAggregationDescriptor<T>
    | Edit this page View Source

    Size(int?)

    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 GeoHashGridAggregationDescriptor<T> Size(int? size)
    Parameters
    Type Name Description
    int? size
    Returns
    Type Description
    GeoHashGridAggregationDescriptor<T>

    Implements

    IDescriptor
    IGeoHashGridAggregation
    IBucketAggregation
    IAggregation

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • Bounds(Func<BoundingBoxDescriptor, IBoundingBox>)
      • Field(Field)
      • Field<TValue>(Expression<Func<T, TValue>>)
      • GeoHashPrecision(GeoHashPrecision?)
      • ShardSize(int?)
      • Size(int?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX