Struct elasticsearch::Mtermvectors

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

Builder for the Mtermvectors API

Returns multiple termvectors in one request.

Implementations

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

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

Creates a new instance of Mtermvectors with the specified API parts

pub fn body<T>(self, body: T) -> Mtermvectors<'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 field_statistics(self, field_statistics: bool) -> Self

Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.

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

A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body “params” or “docs”.

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

A comma-separated list of documents ids. You must define ids as parameter or set “ids” or “docs” in the request body

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

Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.

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

Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.

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

Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.

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

Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body “params” or “docs”.

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

Pretty format the returned JSON response.

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

Specifies if requests are real-time as opposed to near-real-time (default: true).

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. Applies to all returned documents unless otherwise specified in body “params” or “docs”.

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

Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body “params” or “docs”.

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

Explicit version number for concurrency control

pub fn version_type(self, version_type: VersionType) -> Self

Specific version type

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

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

Trait Implementations

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

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

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

Formats the value using the given formatter.