Struct elasticsearch::indices::IndicesFlush

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

Builder for the Indices Flush API

Performs the flush operation on one or more indices.

Implementations

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

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

Creates a new instance of IndicesFlush with the specified API parts

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

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

pub fn body<T>(self, body: T) -> IndicesFlush<'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 expand_wildcards(self, expand_wildcards: &'b [ExpandWildcards]) -> Self

Whether to expand wildcard expression to concrete indices that are open, closed or both.

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

Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)

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

Whether specified concrete indices should be ignored when unavailable (missing or closed)

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

If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running.

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

Creates an asynchronous call to the Indices Flush API that can be awaited

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.