Struct EqlSearch

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

Builder for the Eql Search API

Returns results matching a query expressed in Event Query Language (EQL)

Implementations

impl<'a, 'b, B> EqlSearch<'a, 'b, B>

where B: Body,

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

Creates a new instance of EqlSearch with the specified API parts

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

Control whether the query should keep running in case of shard failures, and return partial results

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

Control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true.

pub fn body<T>(self, body: T) -> EqlSearch<'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 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 keep_alive(self, keep_alive: &'b str) -> Self

Update the time interval in which the results (partial or final) for this search will be available

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

Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)

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

Pretty format the returned JSON response.

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

Specify the time that the request should block waiting for the final response

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

Creates an asynchronous call to the Eql Search API that can be awaited

Trait Implementations

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

fn clone(&self) -> EqlSearch<'a, 'b, B>

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, 'b, B: Debug> Debug for EqlSearch<'a, 'b, B>

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

Formats the value using the given formatter.