Struct elasticsearch_dsl::search::aggregations::bucket::GeotileGridAggregation

pub struct GeotileGridAggregation { /* private fields */ }

A multi-bucket aggregation that groups geo_point and geo_shape values into buckets that represent a grid. The resulting grid can be sparse and only contains cells that have matching data. Each cell corresponds to a map tile as used by many online map sites. Each cell is labeled using a “{zoom}/{x}/{y}” format, where zoom is equal to the user-specified precision.

https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geotilegrid-aggregation.html

Implementations

impl GeotileGridAggregation

pub fn size(self, size: u64) -> Self

The size parameter can be set to define the maximum number of buckets to return.Defaults to 10,000. When results are trimmed, buckets are prioritized based on the volume of documents they contain.

pub fn shard_size(self, shard_size: u64) -> Self

The shard_size parameter limits the number of buckets returned from each shard. Defaults to max(10,(size x number-of-shards)) to allow for a more accurate count of the top cells in the final result.Since each shard could have a different top result order, using a larger number here reduces the risk of inaccurate counts, but incurs a performance cost.

pub fn precision(self, precision: u8) -> Self

the precision parameter is used to define cells/buckets in the results. Defaults to 7. Values outside of [0,29] will be rejected.

pub fn bounds<T>(self, bounds: T) -> Self

where T: Into<GeoBoundingBox>,

the bounds parameter defines the bounding box used to filter the geo-points or geo-shapes in each bucket. Accepts the same bounding box formats as the GeoBoundingBoxQuery

pub fn aggregate<N, A>(self, aggregation_name: N, aggregation: A) -> Self

where N: Into<AggregationName>, A: Into<Aggregation>,

Pushes aggregation

Trait Implementations

impl Clone for GeotileGridAggregation

fn clone(&self) -> GeotileGridAggregation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GeotileGridAggregation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<GeotileGridAggregation> for Aggregation

fn from(q: GeotileGridAggregation) -> Self

Converts to this type from the input type.

impl PartialEq for GeotileGridAggregation

fn eq(&self, other: &GeotileGridAggregation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GeotileGridAggregation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GeotileGridAggregation