Struct FindRules 

pub struct FindRules<'a>(/* private fields */);

GET /api/detection_engine/rules/_find

Implementations

impl<'a> FindRules<'a>

pub fn into_request(self) -> Request<'a>

Converts this builder to a raw request, preserving its configured route, scope, parameters, body, headers and timeout. Replacing the raw body does not reapply this builder’s identity, concurrency or typed-field checks. Existing construction errors remain errors and cannot be repaired through the raw request.

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

Sets a header on this request only. It replaces every value of the same name from the transport defaults or the body.

pub fn request_timeout(self, timeout: Duration) -> Self

Overrides the transport timeout for this request.

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

Sends the request and checks its HTTP status. The successful body remains unread; consume it through Response. Construction errors are returned before HTTP. Requests are never retried.

impl FindRules<'_>

pub fn page(self, page: u32) -> Self

One-based page number.

pub fn per_page(self, per_page: u32) -> Self

pub fn filter(self, filter: &str) -> Self

A KQL filter over rule attributes, for example alert.attributes.enabled: true.

pub fn sort_field(self, field: &str) -> Self

pub fn sort_order(self, order: SortOrder) -> Self

impl<'a> FindRules<'a>

pub fn pages(self) -> BoxStream<'a, Result<RulePage>>

Streams every page from the first, one request per page. Any page set on this builder is ignored.

pub fn items(self) -> BoxStream<'a, Result<<RulePage as Page>::Item>>

Streams every item across all pages. See pages.

pub fn bounded_pages(self, max_pages: u32) -> BoxStream<'a, Result<RulePage>>

Like pages, reading at most max_pages pages. If more remain, the stream ends with Error::PageLimit.

pub fn bounded_items( self, max_pages: u32, ) -> BoxStream<'a, Result<<RulePage as Page>::Item>>

Like items, reading at most max_pages pages. If more remain, the stream ends with Error::PageLimit.

Trait Implementations

impl<'a> Clone for FindRules<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for FindRules<'a>

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

Formats the value using the given formatter.