Struct elasticsearch::SearchMvt

pub struct SearchMvt<'a, 'b, B> { /* private fields */ }

Builder for the Search Mvt API

Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.  

Optional, experimental

This requires the experimental-apis feature. Can have breaking changes in future versions or might even be removed entirely.

Implementations

impl<'a, 'b, B> SearchMvt<'a, 'b, B>where
    B: Body,

pub fn new(transport: &'a Transport, parts: SearchMvtParts<'b>) -> Self

Creates a new instance of SearchMvt with the specified API parts

pub fn body<T>(self, body: T) -> SearchMvt<'a, 'b, JsonBody<T>>where
    T: Serialize,

The body for the API call

pub fn error_trace(self, error_trace: bool) -> Self

Include the stack trace of returned errors.

pub fn exact_bounds(self, exact_bounds: bool) -> Self

If false, the meta layer’s feature is the bounding box of the tile. If true, the meta layer’s feature is a bounding box resulting from a geo_bounds aggregation.

pub fn extent(self, extent: i32) -> Self

Size, in pixels, of a side of the vector tile.

pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self

A comma-separated list of filters used to reduce the response.

pub fn grid_precision(self, grid_precision: i32) -> Self

Additional zoom levels available through the aggs layer. Accepts 0-8.

pub fn grid_type(self, grid_type: GridType) -> Self

Determines the geometry type for features in the aggs layer.

pub fn header(self, key: HeaderName, value: HeaderValue) -> Self

Adds a HTTP header

pub fn human(self, human: bool) -> Self

Return human readable values for statistics.

pub fn pretty(self, pretty: bool) -> Self

Pretty format the returned JSON response.

pub fn request_timeout(self, timeout: Duration) -> Self

Sets a request timeout for this API call.

The timeout is applied from when the request starts connecting until the response body has finished.

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

Maximum number of features to return in the hits layer. Accepts 0-10000.

pub fn source(self, source: &'b str) -> Self

The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

pub fn track_total_hits<T: Into<TrackTotalHits>>(
    self,
    track_total_hits: T
) -> Self

Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.

pub fn with_labels(self, with_labels: bool) -> Self

If true, the hits and aggs layers will contain additional point features with suggested label positions for the original features.

pub async fn send(self) -> Result<Response, Error>

Creates an asynchronous call to the Search Mvt API that can be awaited

Trait Implementations

impl<'a, 'b, B: Clone> Clone for SearchMvt<'a, 'b, B>

fn clone(&self) -> SearchMvt<'a, 'b, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, 'b, B: Debug> Debug for SearchMvt<'a, 'b, B>

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

Formats the value using the given formatter.