Struct elasticsearch::cat::CatTasks

pub struct CatTasks<'a, 'b> { /* private fields */ }

Builder for the Cat Tasks API

Returns information about the tasks currently executing on one or more nodes in the cluster.  

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> CatTasks<'a, 'b>

pub fn new(transport: &'a Transport) -> Self

Creates a new instance of CatTasks

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

A comma-separated list of actions that should be returned. Leave empty to return all.

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

Return detailed task information (default: false)

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

a short version of the Accept header, e.g. json, yaml

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

Comma-separated list of column names to display

pub fn header(self, key: HeaderName, value: HeaderValue) -> Self

Adds a HTTP header

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

Return help information

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

Return tasks with specified parent task id (node_id:task_number). Set to -1 to return 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 s(self, s: &'b [&'b str]) -> Self

Comma-separated list of column names or column aliases to sort by

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 time(self, time: Time) -> Self

The unit in which to display time values

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

Verbose mode. Display column headers

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

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

Trait Implementations

impl<'a, 'b> Clone for CatTasks<'a, 'b>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, 'b> Debug for CatTasks<'a, 'b>

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

Formats the value using the given formatter.