Struct UpdateDocumentRequest 

#[non_exhaustive]
pub struct UpdateDocumentRequest {
    pub document: Option<Document>,
    pub allow_missing: bool,
    pub update_mask: Option<FieldMask>,
    /* private fields */
}

Available on crate feature document-service only.

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

document: Option<Document>

Required. The document to update/create.

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

If the Document to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

allow_missing: bool

If set to true and the Document is not found, a new Document is be created.

update_mask: Option<FieldMask>

Indicates which fields in the provided imported ‘document’ to update. If not set, by default updates all fields.

Implementations

impl UpdateDocumentRequest

pub fn new() -> Self

pub fn set_document<T>(self, v: T) -> Self

where T: Into<Document>,

Sets the value of document.

Example

use google_cloud_discoveryengine_v1::model::Document;
let x = UpdateDocumentRequest::new().set_document(Document::default()/* use setters */);

pub fn set_or_clear_document<T>(self, v: Option<T>) -> Self

where T: Into<Document>,

Sets or clears the value of document.

Example

use google_cloud_discoveryengine_v1::model::Document;
let x = UpdateDocumentRequest::new().set_or_clear_document(Some(Document::default()/* use setters */));
let x = UpdateDocumentRequest::new().set_or_clear_document(None::<Document>);

pub fn set_allow_missing<T: Into<bool>>(self, v: T) -> Self

Sets the value of allow_missing.

Example

let x = UpdateDocumentRequest::new().set_allow_missing(true);

pub fn set_update_mask<T>(self, v: T) -> Self

where T: Into<FieldMask>,

Sets the value of update_mask.

Example

use wkt::FieldMask;
let x = UpdateDocumentRequest::new().set_update_mask(FieldMask::default()/* use setters */);

pub fn set_or_clear_update_mask<T>(self, v: Option<T>) -> Self

where T: Into<FieldMask>,

Sets or clears the value of update_mask.

Example

use wkt::FieldMask;
let x = UpdateDocumentRequest::new().set_or_clear_update_mask(Some(FieldMask::default()/* use setters */));
let x = UpdateDocumentRequest::new().set_or_clear_update_mask(None::<FieldMask>);

Trait Implementations

impl Clone for UpdateDocumentRequest

fn clone(&self) -> UpdateDocumentRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateDocumentRequest

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

Formats the value using the given formatter.

impl Default for UpdateDocumentRequest

fn default() -> UpdateDocumentRequest

Returns the “default value” for a type.

impl Message for UpdateDocumentRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UpdateDocumentRequest

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