Struct elasticsearch::ml::MlCloseJob

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

Builder for the Ml Close Job API

Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.

Implementations

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

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

Creates a new instance of MlCloseJob 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 allow_no_match(self, allow_no_match: 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) -> MlCloseJob<'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 force(self, force: bool) -> Self

True if the job should be forcefully closed

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

Controls the time to wait until a job has closed. Default to 30 minutes

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

Creates an asynchronous call to the Ml Close Job API that can be awaited

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.