Struct ListDocumentsRequest 

#[non_exhaustive]
pub struct ListDocumentsRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    pub filter: String,
    /* private fields */
}

Available on crate feature documents only.

Request message for Documents.ListDocuments.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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:

<field> <operator> <value> [AND <field> <operator> <value>] …

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.

Implementations

impl ListDocumentsRequest

pub fn new() -> Self

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

Example

let x = ListDocumentsRequest::new().set_parent("example");

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

Example

let x = ListDocumentsRequest::new().set_page_size(42);

pub fn set_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of page_token.

Example

let x = ListDocumentsRequest::new().set_page_token("example");

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

Example

let x = ListDocumentsRequest::new().set_filter("example");

Trait Implementations

impl Clone for ListDocumentsRequest

fn clone(&self) -> ListDocumentsRequest

Returns a duplicate 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() -> ListDocumentsRequest

Returns the “default value” for a type.

impl Message for ListDocumentsRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ListDocumentsRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ListDocumentsRequest