Struct PurgeDocumentsResponse 

#[non_exhaustive]
pub struct PurgeDocumentsResponse {
    pub purge_count: i64,
    pub purge_sample: Vec<String>,
    /* private fields */
}

Available on crate feature document-service only.

Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

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.

purge_count: i64

The total count of documents purged as a result of the operation.

purge_sample: Vec<String>

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

Implementations

impl PurgeDocumentsResponse

pub fn new() -> Self

pub fn set_purge_count<T: Into<i64>>(self, v: T) -> Self

Sets the value of purge_count.

Example

let x = PurgeDocumentsResponse::new().set_purge_count(42);

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

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of purge_sample.

Example

let x = PurgeDocumentsResponse::new().set_purge_sample(["a", "b", "c"]);

Trait Implementations

impl Clone for PurgeDocumentsResponse

fn clone(&self) -> PurgeDocumentsResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PurgeDocumentsResponse

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

Formats the value using the given formatter.

impl Default for PurgeDocumentsResponse

fn default() -> PurgeDocumentsResponse

Returns the “default value” for a type.

impl Message for PurgeDocumentsResponse

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PurgeDocumentsResponse

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