Struct google_api_proto::google::firestore::admin::v1::BulkDeleteDocumentsRequest

pub struct BulkDeleteDocumentsRequest {
    pub name: String,
    pub collection_ids: Vec<String>,
    pub namespace_ids: Vec<String>,
}

The request for [FirestoreAdmin.BulkDeleteDocuments][google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments].

When both collection_ids and namespace_ids are set, only documents satisfying both conditions will be deleted.

Requests with namespace_ids and collection_ids both empty will be rejected. Please use [FirestoreAdmin.DeleteDatabase][google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase] instead.

Fields

name: String

Required. Database to operate. Should be of the form: projects/{project_id}/databases/{database_id}.

collection_ids: Vec<String>

Optional. IDs of the collection groups to delete. Unspecified means all collection groups.

Each collection group in this list must be unique.

namespace_ids: Vec<String>

Optional. Namespaces to delete.

An empty list means all namespaces. This is the recommended usage for databases that don’t use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn’t want to delete from them.

Each namespace in this list must be unique.

Trait Implementations

impl Clone for BulkDeleteDocumentsRequest

fn clone(&self) -> BulkDeleteDocumentsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BulkDeleteDocumentsRequest

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

Formats the value using the given formatter.

impl Default for BulkDeleteDocumentsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for BulkDeleteDocumentsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for BulkDeleteDocumentsRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for BulkDeleteDocumentsRequest