Firestore Admin v1 API - Class BulkDeleteDocumentsRequest (3.11.0)

Version latest

• 3.11.0 (latest)
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.4.0
• 2.3.0
• 2.2.0

public sealed class BulkDeleteDocumentsRequest : IMessage<BulkDeleteDocumentsRequest>, IEquatable<BulkDeleteDocumentsRequest>, IDeepCloneable<BulkDeleteDocumentsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore Admin v1 API class BulkDeleteDocumentsRequest.

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.

Inheritance

object > BulkDeleteDocumentsRequest

Implements

IMessageBulkDeleteDocumentsRequest, IEquatableBulkDeleteDocumentsRequest, IDeepCloneableBulkDeleteDocumentsRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

BulkDeleteDocumentsRequest()

public BulkDeleteDocumentsRequest()

BulkDeleteDocumentsRequest(BulkDeleteDocumentsRequest)

public BulkDeleteDocumentsRequest(BulkDeleteDocumentsRequest other)

Parameter
Name	Description
other	BulkDeleteDocumentsRequest

Properties

CollectionIds

public RepeatedField<string> CollectionIds { get; }

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

Each collection group in this list must be unique.

Property Value
Type	Description
RepeatedFieldstring

DatabaseName

public DatabaseName DatabaseName { get; set; }

DatabaseName-typed view over the Name resource name property.

Property Value
Type	Description
DatabaseName

Name

public string Name { get; set; }

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

Property Value
Type	Description
string

NamespaceIds

public RepeatedField<string> NamespaceIds { get; }

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.

Property Value
Type	Description
RepeatedFieldstring