Struct Msearch

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

Builder for the Msearch API

Allows to execute several search operations in one request.

Implementations

impl<'a, 'b, B> Msearch<'a, 'b, B>

where B: Body,

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

Creates a new instance of Msearch with the specified API parts

pub fn body<T>(self, body: Vec<T>) -> Msearch<'a, 'b, NdBody<T>>

where T: Body,

The body for the API call

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

Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution

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

Include the stack trace of returned errors.

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

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

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 max_concurrent_searches(self, max_concurrent_searches: i64) -> Self

Controls the maximum number of concurrent searches the multi search api will execute

pub fn max_concurrent_shard_requests( self, max_concurrent_shard_requests: i64, ) -> Self

The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests

pub fn pre_filter_shard_size(self, pre_filter_shard_size: i64) -> Self

A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.

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 rest_total_hits_as_int(self, rest_total_hits_as_int: bool) -> Self

Indicates whether hits.total should be rendered as an integer or an object in the rest search response

pub fn search_type(self, search_type: SearchType) -> Self

Search operation type

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 typed_keys(self, typed_keys: bool) -> Self

Specify whether aggregation and suggester names should be prefixed by their respective types in the response

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

Creates an asynchronous call to the Msearch API that can be awaited

Trait Implementations

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

fn clone(&self) -> Msearch<'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 Msearch<'a, 'b, B>

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

Formats the value using the given formatter.