Struct elasticsearch::ml::MlGetBuckets

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

Builder for the Ml Get Buckets API

Retrieves anomaly detection job results for one or more buckets.

Implementations

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

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

Creates a new instance of MlGetBuckets with the specified API parts

pub fn anomaly_score(self, anomaly_score: f64) -> Self

Filter for the most anomalous buckets

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

The body for the API call

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

Set the sort direction

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

End time filter for buckets

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

Include the stack trace of returned errors.

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

Exclude interim results

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

Include anomaly records

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

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

pub fn from(self, from: i32) -> Self

skips a number of buckets

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 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 size(self, size: i32) -> Self

specifies a max number of buckets to get

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

Sort buckets by a particular field

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

Start time filter for buckets

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

Creates an asynchronous call to the Ml Get Buckets API that can be awaited

Trait Implementations

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

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

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

Formats the value using the given formatter.