Struct DeleteDocumentRequest 

#[non_exhaustive]
pub struct DeleteDocumentRequest {
    pub name: String,
    /* private fields */
}

Available on crate feature document-service only.

Request message for DocumentService.DeleteDocument 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.

name: String

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the Document to delete does not exist, a NOT_FOUND error is returned.

Implementations

impl DeleteDocumentRequest

pub fn new() -> Self

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

Sets the value of name.

Example

let x = DeleteDocumentRequest::new().set_name("example");

Trait Implementations

impl Clone for DeleteDocumentRequest

fn clone(&self) -> DeleteDocumentRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteDocumentRequest

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

Formats the value using the given formatter.

impl Default for DeleteDocumentRequest

fn default() -> DeleteDocumentRequest

Returns the “default value” for a type.

impl Message for DeleteDocumentRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DeleteDocumentRequest

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