Struct elasticsearch::ml::MlGetOverallBuckets

pub struct MlGetOverallBuckets<'a, 'b, B> { /* fields omitted */ }

Builder for the Ml Get Overall Buckets API.

Methods

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

pub fn new(
    client: &'a Elasticsearch,
    parts: MlGetOverallBucketsParts<'b>
) -> Self

Creates a new instance of MlGetOverallBuckets with the specified API parts

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

Whether to ignore if a wildcard expression matches no jobs. (This includes _all string or when no jobs have been specified)

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

The body for the API call

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

The span of the overall buckets. Defaults to the longest job bucket_span

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

Returns overall buckets with timestamps earlier than this time

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

If true overall buckets that include interim buckets will be excluded

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 overall_score(self, overall_score: f64) -> Self

Returns overall buckets with overall scores higher than this value

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

Pretty format the returned JSON response.

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

Returns overall buckets with timestamps after this time

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

The number of top job bucket scores to be used in the overall_score calculation

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

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

Trait Implementations

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

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

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

Formats the value using the given formatter.