Struct google_api_proto::google::cloud::contentwarehouse::v1::HistogramQuery

pub struct HistogramQuery {
    pub histogram_query: String,
    pub require_precise_result_size: bool,
    pub filters: Option<HistogramQueryPropertyNameFilter>,
}

The histogram request.

Fields

histogram_query: String

An expression specifies a histogram request against matching documents for searches.

See [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries] for details about syntax.

require_precise_result_size: bool

Controls if the histogram query requires the return of a precise count. Enable this flag may adversely impact performance.

Defaults to true.

filters: Option<HistogramQueryPropertyNameFilter>

Optional. Filter the result of histogram query by the property names. It only works with histogram query count(‘FilterableProperties’). It is an optional. It will perform histogram on all the property names for all the document schemas. Setting this field will have a better performance.

Trait Implementations

impl Clone for HistogramQuery

fn clone(&self) -> HistogramQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HistogramQuery

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

Formats the value using the given formatter.

impl Default for HistogramQuery

fn default() -> Self

Returns the “default value” for a type.

impl Message for HistogramQuery

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for HistogramQuery

fn eq(&self, other: &HistogramQuery) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HistogramQuery