[−][src]Struct elasticsearch::Explain
Builder for the Explain API
Returns information about why a specific matches (or doesn't match) a query.
Implementations
impl<'a, 'b, B> Explain<'a, 'b, B> where
B: Body,
[src]
B: Body,
pub fn new(transport: &'a Transport, parts: ExplainParts<'b>) -> Self
[src]
Creates a new instance of Explain with the specified API parts
pub fn _source(self, _source: &'b [&'b str]) -> Self
[src]
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
[src]
A list of fields to exclude from the returned _source field
pub fn _source_includes(self, _source_includes: &'b [&'b str]) -> Self
[src]
A list of fields to extract and return from the _source field
pub fn analyze_wildcard(self, analyze_wildcard: bool) -> Self
[src]
Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
pub fn analyzer(self, analyzer: &'b str) -> Self
[src]
The analyzer for the query string query
pub fn body<T>(self, body: T) -> Explain<'a, 'b, JsonBody<T>> where
T: Serialize,
[src]
T: Serialize,
The body for the API call
pub fn default_operator(self, default_operator: DefaultOperator) -> Self
[src]
The default operator for query string query (AND or OR)
pub fn df(self, df: &'b str) -> Self
[src]
The default field for query string query (default: _all)
pub fn error_trace(self, error_trace: bool) -> Self
[src]
Include the stack trace of returned errors.
pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self
[src]
A comma-separated list of filters used to reduce the response.
pub fn header(self, key: HeaderName, value: HeaderValue) -> Self
[src]
Adds a HTTP header
pub fn human(self, human: bool) -> Self
[src]
Return human readable values for statistics.
pub fn lenient(self, lenient: bool) -> Self
[src]
Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
pub fn preference(self, preference: &'b str) -> Self
[src]
Specify the node or shard the operation should be performed on (default: random)
pub fn pretty(self, pretty: bool) -> Self
[src]
Pretty format the returned JSON response.
pub fn q(self, q: &'b str) -> Self
[src]
Query in the Lucene query string syntax
pub fn routing(self, routing: &'b str) -> Self
[src]
Specific routing value
pub fn source(self, source: &'b str) -> Self
[src]
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
[src]
A comma-separated list of stored fields to return in the response
pub async fn send(self) -> Result<Response, Error>
[src]
Creates an asynchronous call to the Explain API that can be awaited
Trait Implementations
impl<'a, 'b, B: Clone> Clone for Explain<'a, 'b, B>
[src]
impl<'a, 'b, B: Debug> Debug for Explain<'a, 'b, B>
[src]
Auto Trait Implementations
impl<'a, 'b, B> !RefUnwindSafe for Explain<'a, 'b, B>
impl<'a, 'b, B> Send for Explain<'a, 'b, B> where
B: Send,
B: Send,
impl<'a, 'b, B> Sync for Explain<'a, 'b, B> where
B: Sync,
B: Sync,
impl<'a, 'b, B> Unpin for Explain<'a, 'b, B> where
B: Unpin,
B: Unpin,
impl<'a, 'b, B> !UnwindSafe for Explain<'a, 'b, B>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DynClone for T where
T: Clone,
[src]
T: Clone,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,