Struct elasticsearch::SearchTemplate

pub struct SearchTemplate<'a, 'b, B> { /* fields omitted */ }

Builder for the Search Template API

Allows to use the Mustache language to pre-render a search definition.

Implementations

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

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

Creates a new instance of SearchTemplate with the specified API parts

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

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

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

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

Whether to expand wildcard expression to concrete indices that are open, closed or both.

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

Specify whether to return detailed information about score computation as part of a hit

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

Whether specified concrete, expanded or aliased indices should be ignored when throttled

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

Whether specified concrete indices should be ignored when unavailable (missing or closed)

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

Specify whether to profile the query execution

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

A comma-separated list of specific routing values

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

Specify how long a consistent view of the index should be maintained for scrolled search

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 Search Template API that can be awaited

Trait Implementations

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

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

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

Formats the value using the given formatter.