Struct Index

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

Builder for the Index API

Creates or updates a document in an index.

Implementations

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

where B: Body,

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

Creates a new instance of Index with the specified API parts

pub fn body<T>(self, body: T) -> Index<'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 index 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 index 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 op_type(self, op_type: OpType) -> Self

Explicit operation type. Defaults to index for requests with an explicit document ID, and to createfor requests without an explicit document ID

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

The pipeline id to preprocess incoming documents with

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 to be an alias. Default is false

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

When true, requires the destination to be a data stream (existing or to-be-created). Default is false

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

Explicit version number for concurrency control

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

Specific version type

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 index 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 Index API that can be awaited

Trait Implementations

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

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

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

Formats the value using the given formatter.