Struct elasticsearch::tasks::TasksCancel
source · pub struct TasksCancel<'a, 'b, B> { /* private fields */ }
Expand description
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
sourceimpl<'a, 'b, B> TasksCancel<'a, 'b, B>where
B: Body,
impl<'a, 'b, B> TasksCancel<'a, 'b, B>where
B: Body,
sourcepub fn new(transport: &'a Transport, parts: TasksCancelParts<'b>) -> Self
pub fn new(transport: &'a Transport, parts: TasksCancelParts<'b>) -> Self
Creates a new instance of TasksCancel with the specified API parts
sourcepub fn actions(self, actions: &'b [&'b str]) -> Self
pub fn actions(self, actions: &'b [&'b str]) -> Self
A comma-separated list of actions that should be cancelled. Leave empty to cancel all.
sourcepub fn body<T>(self, body: T) -> TasksCancel<'a, 'b, JsonBody<T>>where
T: Serialize,
pub fn body<T>(self, body: T) -> TasksCancel<'a, 'b, JsonBody<T>>where
T: Serialize,
The body for the API call
sourcepub fn error_trace(self, error_trace: bool) -> Self
pub fn error_trace(self, error_trace: bool) -> Self
Include the stack trace of returned errors.
sourcepub fn filter_path(self, filter_path: &'b [&'b str]) -> Self
pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self
A comma-separated list of filters used to reduce the response.
sourcepub fn header(self, key: HeaderName, value: HeaderValue) -> Self
pub fn header(self, key: HeaderName, value: HeaderValue) -> Self
Adds a HTTP header
sourcepub fn nodes(self, nodes: &'b [&'b str]) -> Self
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
sourcepub fn parent_task_id(self, parent_task_id: &'b str) -> Self
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.
sourcepub fn request_timeout(self, timeout: Duration) -> Self
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.
sourcepub fn source(self, source: &'b str) -> Self
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.
sourcepub fn wait_for_completion(self, wait_for_completion: bool) -> Self
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
Trait Implementations
sourceimpl<'a, 'b, B: Clone> Clone for TasksCancel<'a, 'b, B>
impl<'a, 'b, B: Clone> Clone for TasksCancel<'a, 'b, B>
sourcefn clone(&self) -> TasksCancel<'a, 'b, B>
fn clone(&self) -> TasksCancel<'a, 'b, B>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more