Struct ListDocumentsRequest 

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

Available on crate feature document-service only.

Request message for DocumentService.ListDocuments method.

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 parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Use default_branch as the branch ID, to list documents under the default branch.

If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

page_size: i32

Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

page_token: String

A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

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");

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