Struct EqlSearch

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

Builder for the Eql Search API

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

Implementations§

Source§

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

Source

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

Creates a new instance of EqlSearch with the specified API parts

Source

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

Source

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.

Source

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

The body for the API call

Source

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

Include the stack trace of returned errors.

Source

pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self

A comma-separated list of filters used to reduce the response.

Source

pub fn header(self, key: HeaderName, value: HeaderValue) -> Self

Adds a HTTP header

Source

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

Return human readable values for statistics.

Source

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

Source

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)

Source

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

Pretty format the returned JSON response.

Source

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.

Source

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.

Source

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

Source

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

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

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, 'b, B> Freeze for EqlSearch<'a, 'b, B>
where B: Freeze,

§

impl<'a, 'b, B> !RefUnwindSafe for EqlSearch<'a, 'b, B>

§

impl<'a, 'b, B> Send for EqlSearch<'a, 'b, B>
where B: Send,

§

impl<'a, 'b, B> Sync for EqlSearch<'a, 'b, B>
where B: Sync,

§

impl<'a, 'b, B> Unpin for EqlSearch<'a, 'b, B>
where B: Unpin,

§

impl<'a, 'b, B> !UnwindSafe for EqlSearch<'a, 'b, B>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> MaybeSendSync for T