Struct Update

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

Builder for the Update API

Updates a document with a script or partial document.

Implementations

impl<'a, 'b, B> Update<'a, 'b, B>

where B: Body,

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

Creates a new instance of Update with the specified API parts

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

True or false to return the _source field or not, or a list of fields to return

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

A list of fields to exclude from the returned _source field

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

A list of fields to extract and return from the _source field

pub fn body<T>(self, body: T) -> Update<'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 filter_path(self, filter_path: &'b [&'b str]) -> Self

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

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 if_primary_term(self, if_primary_term: i64) -> Self

only perform the update 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

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

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

True or false if to include the document source in the error message in case of parsing errors. Defaults to true.

pub fn lang(self, lang: &'b str) -> Self

The script language (default: painless)

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

Pretty format the returned JSON response.

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

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

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

When true, requires destination is an alias. Default is false

pub fn retry_on_conflict(self, retry_on_conflict: i64) -> Self

Specify how many times should the operation be retried when a conflict occurs (default: 0)

pub fn routing(self, routing: &'b str) -> Self

Specific routing value

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

Explicit operation timeout

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

Sets the number of shard copies that must be active before proceeding with the update 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>

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

Trait Implementations

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

fn clone(&self) -> Update<'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 Update<'a, 'b, B>

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

Formats the value using the given formatter.