[][src]Struct elasticsearch::Delete

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

Builder for the Delete API

Removes a document from the index.

Implementations

impl<'a, 'b> Delete<'a, 'b>[src]

pub fn new(transport: &'a Transport, parts: DeleteParts<'b>) -> Self[src]

Creates a new instance of Delete with the specified API parts

pub fn error_trace(self, error_trace: bool) -> Self[src]

Include the stack trace of returned errors.

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

A comma-separated list of filters used to reduce the response.

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

Adds a HTTP header

pub fn human(self, human: bool) -> Self[src]

Return human readable values for statistics.

pub fn if_primary_term(self, if_primary_term: i64) -> Self[src]

only perform the delete operation if the last operation that has changed the document has the specified primary term

pub fn if_seq_no(self, if_seq_no: i64) -> Self[src]

only perform the delete operation if the last operation that has changed the document has the specified sequence number

pub fn pretty(self, pretty: bool) -> Self[src]

Pretty format the returned JSON response.

pub fn refresh(self, refresh: Refresh) -> Self[src]

If true then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false (the default) then do nothing with refreshes.

pub fn request_timeout(self, timeout: Duration) -> Self[src]

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 routing(self, routing: &'b str) -> Self[src]

Specific routing value

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

The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

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

Explicit operation timeout

pub fn version(self, version: i64) -> Self[src]

Explicit version number for concurrency control

pub fn version_type(self, version_type: VersionType) -> Self[src]

Specific version type

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

Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to all for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)

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

Creates an asynchronous call to the Delete API that can be awaited

Trait Implementations

impl<'a, 'b> Clone for Delete<'a, 'b>[src]

impl<'a, 'b> Debug for Delete<'a, 'b>[src]

Auto Trait Implementations

impl<'a, 'b> !RefUnwindSafe for Delete<'a, 'b>

impl<'a, 'b> Send for Delete<'a, 'b>

impl<'a, 'b> Sync for Delete<'a, 'b>

impl<'a, 'b> Unpin for Delete<'a, 'b>

impl<'a, 'b> !UnwindSafe for Delete<'a, 'b>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DynClone for T where
    T: Clone
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.