Struct elasticsearch_dsl::search::queries::specialized::PercolateLookupQuery

pub struct PercolateLookupQuery { /* private fields */ }

In order to percolate a newly indexed document, the percolate query can be used. Based on the response from an index request, the _id and other meta information can be used to immediately percolate the newly added document.

To percolate indexed document:

Query::percolate_lookup("field", "index_name", "document_id");

https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-percolate-query.html#_percolating_an_existing_document

Implementations

impl PercolateLookupQuery

pub fn routing<S>(self, routing: S) -> Selfwhere
    S: ToString,

Routing to be used to fetch document to percolate

pub fn preference<S>(self, preference: S) -> Selfwhere
    S: ToString,

Preference to be used to fetch document to percolate

pub fn version(self, version: u64) -> Self

The expected version of the document to be fetched

pub fn name<S>(self, name: S) -> Selfwhere
    S: ToString,

The suffix to be used for the _percolator_document_slot field in case multiple percolate queries have been specified. This is an optional parameter

Trait Implementations

impl Clone for PercolateLookupQuery

fn clone(&self) -> PercolateLookupQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PercolateLookupQuery

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

Formats the value using the given formatter.

impl From<PercolateLookupQuery> for Option<Query>

fn from(q: PercolateLookupQuery) -> Self

Converts to this type from the input type.

impl From<PercolateLookupQuery> for Query

fn from(q: PercolateLookupQuery) -> Self

Converts to this type from the input type.

impl IntoIterator for PercolateLookupQuery

type Item = PercolateLookupQuery

The type of the elements being iterated over.

type IntoIter = IntoIter<<PercolateLookupQuery as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<PercolateLookupQuery> for PercolateLookupQuery

fn eq(&self, other: &PercolateLookupQuery) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<PercolateLookupQuery> for Query

fn eq(&self, other: &PercolateLookupQuery) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Query> for PercolateLookupQuery

fn eq(&self, other: &Query) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PercolateLookupQuery

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PercolateLookupQuery

impl StructuralEq for PercolateLookupQuery

impl StructuralPartialEq for PercolateLookupQuery