Struct elasticsearch::tasks::TasksList
source · pub struct TasksList<'a, 'b> { /* private fields */ }
Expand description
Builder for the Tasks List API
Returns a list of tasks.
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> TasksList<'a, 'b>
impl<'a, 'b> TasksList<'a, 'b>
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 returned. Leave empty to return all.
sourcepub fn detailed(self, detailed: bool) -> Self
pub fn detailed(self, detailed: bool) -> Self
Return detailed task information (default: false)
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 group_by(self, group_by: GroupBy) -> Self
pub fn group_by(self, group_by: GroupBy) -> Self
Group tasks by nodes or parent/child relationships
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
Return tasks with specified parent task id (node_id:task_number). Set to -1 to return 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
Wait for the matching tasks to complete (default: false)