Struct elasticsearch::tasks::TasksCancel

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

Builder for the Tasks Cancel API

Cancels a task, if it can be cancelled through an API.  

Optional, experimental

This requires the experimental-apis feature. Can have breaking changes in future versions or might even be removed entirely.

Implementations

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

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

Creates a new instance of TasksCancel with the specified API parts

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

A comma-separated list of actions that should be cancelled. Leave empty to cancel all.

pub fn body<T>(self, body: T) -> TasksCancel<'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 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 nodes(self, nodes: &'b [&'b str]) -> Self

A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you’re connecting to, leave empty to get information from all nodes

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

Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.

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 wait_for_completion(self, wait_for_completion: bool) -> Self

Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false

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

Creates an asynchronous call to the Tasks Cancel API that can be awaited

Trait Implementations

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

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

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

Formats the value using the given formatter.