Struct elasticsearch_dsl::search::queries::specialized::PercolateQuery

pub struct PercolateQuery { /* private fields */ }

The percolate query can be used to match queries stored in an index. The percolate query itself contains the document that will be used as query to match with the stored queries.

To percolate single document:

Query::percolate("field", json!({ "message": "search text" }));

To percolate multiple documents:

Query::percolate("field", vec![json!({ "message": "search text" }), json!({ "message": "another search text" })]);

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

Implementations

impl PercolateQuery

pub fn name<S>(self, name: S) -> Self where
    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 PercolateQuery

fn clone(&self) -> PercolateQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PercolateQuery

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

Formats the value using the given formatter.

impl From<PercolateQuery> for Query

fn from(q: PercolateQuery) -> Self

Converts to this type from the input type.

impl From<PercolateQuery> for Option<Query>

fn from(q: PercolateQuery) -> Self

Converts to this type from the input type.

impl From<PercolateQuery> for Queries

fn from(q: PercolateQuery) -> Self

Converts to this type from the input type.

impl PartialEq<PercolateQuery> for PercolateQuery

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

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

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

This method tests for !=.

impl PartialEq<PercolateQuery> for Query

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

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

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

This method tests for !=.

impl PartialEq<Query> for PercolateQuery

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

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

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

This method tests for !=.

impl Serialize for PercolateQuery

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PercolateQuery