Struct elasticsearch::SearchTemplate
source · pub struct SearchTemplate<'a, 'b, B> { /* private fields */ }
Expand description
Builder for the Search Template API
Allows to use the Mustache language to pre-render a search definition.
Implementations
sourceimpl<'a, 'b, B> SearchTemplate<'a, 'b, B>where
B: Body,
impl<'a, 'b, B> SearchTemplate<'a, 'b, B>where
B: Body,
sourcepub fn new(transport: &'a Transport, parts: SearchTemplateParts<'b>) -> Self
pub fn new(transport: &'a Transport, parts: SearchTemplateParts<'b>) -> Self
Creates a new instance of SearchTemplate with the specified API parts
sourcepub fn allow_no_indices(self, allow_no_indices: bool) -> Self
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)
sourcepub fn body<T>(self, body: T) -> SearchTemplate<'a, 'b, JsonBody<T>>where
T: Serialize,
pub fn body<T>(self, body: T) -> SearchTemplate<'a, 'b, JsonBody<T>>where
T: Serialize,
The body for the API call
sourcepub fn ccs_minimize_roundtrips(self, ccs_minimize_roundtrips: bool) -> Self
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
sourcepub fn error_trace(self, error_trace: bool) -> Self
pub fn error_trace(self, error_trace: bool) -> Self
Include the stack trace of returned errors.
sourcepub fn expand_wildcards(self, expand_wildcards: &'b [ExpandWildcards]) -> Self
pub fn expand_wildcards(self, expand_wildcards: &'b [ExpandWildcards]) -> Self
Whether to expand wildcard expression to concrete indices that are open, closed or both.
sourcepub fn explain(self, explain: bool) -> Self
pub fn explain(self, explain: bool) -> Self
Specify whether to return detailed information about score computation as part of a hit
sourcepub fn filter_path(self, filter_path: &'b [&'b str]) -> Self
pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self
A comma-separated list of filters used to reduce the response.
sourcepub fn header(self, key: HeaderName, value: HeaderValue) -> Self
pub fn header(self, key: HeaderName, value: HeaderValue) -> Self
Adds a HTTP header
sourcepub fn ignore_throttled(self, ignore_throttled: bool) -> Self
pub fn ignore_throttled(self, ignore_throttled: bool) -> Self
Whether specified concrete, expanded or aliased indices should be ignored when throttled
Whether specified concrete indices should be ignored when unavailable (missing or closed)
sourcepub fn preference(self, preference: &'b str) -> Self
pub fn preference(self, preference: &'b str) -> Self
Specify the node or shard the operation should be performed on (default: random)
sourcepub fn request_timeout(self, timeout: Duration) -> Self
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.
sourcepub fn rest_total_hits_as_int(self, rest_total_hits_as_int: bool) -> Self
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
sourcepub fn routing(self, routing: &'b [&'b str]) -> Self
pub fn routing(self, routing: &'b [&'b str]) -> Self
A comma-separated list of specific routing values
sourcepub fn scroll(self, scroll: &'b str) -> Self
pub fn scroll(self, scroll: &'b str) -> Self
Specify how long a consistent view of the index should be maintained for scrolled search
sourcepub fn search_type(self, search_type: SearchType) -> Self
pub fn search_type(self, search_type: SearchType) -> Self
Search operation type
sourcepub fn source(self, source: &'b str) -> Self
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.
sourcepub fn typed_keys(self, typed_keys: bool) -> Self
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
Trait Implementations
sourceimpl<'a, 'b, B: Clone> Clone for SearchTemplate<'a, 'b, B>
impl<'a, 'b, B: Clone> Clone for SearchTemplate<'a, 'b, B>
sourcefn clone(&self) -> SearchTemplate<'a, 'b, B>
fn clone(&self) -> SearchTemplate<'a, 'b, B>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more