Struct google_api_proto::google::cloud::contentwarehouse::v1::SearchDocumentsResponse

pub struct SearchDocumentsResponse {
    pub matching_documents: Vec<MatchingDocument>,
    pub next_page_token: String,
    pub total_size: i32,
    pub metadata: Option<ResponseMetadata>,
    pub histogram_query_results: Vec<HistogramQueryResult>,
    pub question_answer: String,
}

Response message for DocumentService.SearchDocuments.

Fields

matching_documents: Vec<MatchingDocument>

The document entities that match the specified [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].

next_page_token: String

The token that specifies the starting position of the next page of results. This field is empty if there are no more results.

total_size: i32

The total number of matched documents which is available only if the client set [SearchDocumentsRequest.require_total_size][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.require_total_size] to true or set [SearchDocumentsRequest.total_result_size][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.total_result_size] to ESTIMATED_SIZE or ACTUAL_SIZE. Otherwise, the value will be -1. Typically a UI would handle this condition by displaying "of many", for example: "Displaying 10 of many".

metadata: Option<ResponseMetadata>

Additional information for the API invocation, such as the request tracking id.

histogram_query_results: Vec<HistogramQueryResult>

The histogram results that match with the specified [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].

question_answer: String

Experimental. Question answer from the query against the document.

Trait Implementations

impl Clone for SearchDocumentsResponse

fn clone(&self) -> SearchDocumentsResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchDocumentsResponse

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

Formats the value using the given formatter.

impl Default for SearchDocumentsResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for SearchDocumentsResponse

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where 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( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where 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(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for SearchDocumentsResponse

fn eq(&self, other: &SearchDocumentsResponse) -> 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 SearchDocumentsResponse