Struct google_api_proto::google::cloud::dialogflow::v2beta1::ListDocumentsRequest

pub struct ListDocumentsRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    pub filter: String,
}

Request message for [Documents.ListDocuments][google.cloud.dialogflow.v2beta1.Documents.ListDocuments].

Fields

parent: String

Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

page_size: i32

The maximum number of items to return in a single page. By default 10 and at most 100.

page_token: String

The next_page_token value returned from a previous list request.

filter: String

The filter expression used to filter documents returned by the list method. The expression has the following syntax:

[AND ] …

The following fields and operators are supported:

• knowledge_types with has(:) operator
• display_name with has(:) operator
• state with equals(=) operator

Examples:

• “knowledge_types:FAQ” matches documents with FAQ knowledge type.
• “display_name:customer” matches documents whose display name contains “customer”.
• “state=ACTIVE” matches documents with ACTIVE state.
• “knowledge_types:FAQ AND state=ACTIVE” matches all active FAQ documents.

For more information about filtering, see API Filtering.

Trait Implementations

impl Clone for ListDocumentsRequest

fn clone(&self) -> ListDocumentsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListDocumentsRequest

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

Formats the value using the given formatter.

impl Default for ListDocumentsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListDocumentsRequest

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 ListDocumentsRequest

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