Struct elasticsearch::Mget

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

Builder for the Mget API

Allows to get multiple documents in one request.

Implementations

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

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

Creates a new instance of Mget with the specified API parts

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

True or false to return the _source field or not, or a list of fields to return

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

A list of fields to exclude from the returned _source field

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

A list of fields to extract and return from the _source field

pub fn body<T>(self, body: T) -> Mget<'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 filter_path(self, filter_path: &'b [&'b str]) -> Self

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

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

Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.

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 preference(self, preference: &'b str) -> Self

Specify the node or shard the operation should be performed on (default: random)

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

Pretty format the returned JSON response.

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

Specify whether to perform the operation in realtime or search mode

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

Refresh the shard containing the document before performing the operation

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 routing(self, routing: &'b str) -> Self

Specific routing value

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 stored_fields(self, stored_fields: &'b [&'b str]) -> Self

A comma-separated list of stored fields to return in the response

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

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

Trait Implementations

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

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

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

Formats the value using the given formatter.