Struct GeotileGridAggregation

Source
pub struct GeotileGridAggregation { /* private fields */ }
Expand description

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§

Source§

impl GeotileGridAggregation

Source

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.

Source

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.

Source

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.

Source

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

Source

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

Pushes aggregation

Trait Implementations§

Source§

impl Clone for GeotileGridAggregation

Source§

fn clone(&self) -> GeotileGridAggregation

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GeotileGridAggregation

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<GeotileGridAggregation> for Aggregation

Source§

fn from(q: GeotileGridAggregation) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for GeotileGridAggregation

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for GeotileGridAggregation

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for GeotileGridAggregation

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.