GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1BulkDeleteDocumentsRequest (google_api_firestore v0.33.0)

View Source

The request for 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 instead.

Attributes

  • collectionIds (type: list(String.t), default: nil) - Optional. IDs of the collection groups to delete. Unspecified means all collection groups. Each collection group in this list must be unique.
  • namespaceIds (type: list(String.t), default: nil) - 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.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1BulkDeleteDocumentsRequest{
    collectionIds: [String.t()] | nil,
    namespaceIds: [String.t()] | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.