Struct elasticsearch::indices::IndicesValidateQuery

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

Builder for the Indices Validate Query API

Allows a user to validate a potentially expensive query without executing it.

Implementations

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

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

Creates a new instance of IndicesValidateQuery with the specified API parts

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

Execute validation on all shards instead of one random shard per index

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

Specify whether wildcard and prefix queries should be analyzed (default: false)

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

The analyzer to use for the query string

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

The body for the API call

pub fn default_operator(self, default_operator: DefaultOperator) -> Self

The default operator for query string query (AND or OR)

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

The field to use as default where no field prefix is given in the query string

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

Return detailed information about the error

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

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

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

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

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

Pretty format the returned JSON response.

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

Query in the Lucene query string syntax

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

Provide a more detailed explanation showing the actual Lucene query that will be executed.

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 async fn send(self) -> Result<Response, Error>

Creates an asynchronous call to the Indices Validate Query API that can be awaited

Trait Implementations

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

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

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

Formats the value using the given formatter.