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.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#collection_ids
defcollection_ids()->::Array<::String>
Returns
(::Array<::String>) — Optional. IDs of the collection groups to delete. Unspecified means all
collection groups.
Each collection group in this list must be unique.
#collection_ids=
defcollection_ids=(value)->::Array<::String>
Parameter
value (::Array<::String>) — Optional. IDs of the collection groups to delete. Unspecified means all
collection groups.
Each collection group in this list must be unique.
Returns
(::Array<::String>) — Optional. IDs of the collection groups to delete. Unspecified means all
collection groups.
Each collection group in this list must be unique.
#name
defname()->::String
Returns
(::String) — Required. Database to operate. Should be of the form:
projects/{project_id}/databases/{database_id}.
#name=
defname=(value)->::String
Parameter
value (::String) — Required. Database to operate. Should be of the form:
projects/{project_id}/databases/{database_id}.
Returns
(::String) — Required. Database to operate. Should be of the form:
projects/{project_id}/databases/{database_id}.
#namespace_ids
defnamespace_ids()->::Array<::String>
Returns
(::Array<::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.
#namespace_ids=
defnamespace_ids=(value)->::Array<::String>
Parameter
value (::Array<::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.
Returns
(::Array<::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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsRequest (v1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [1.6.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.6.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [1.5.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.5.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [1.4.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.4.1/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.3.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.2.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.1.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.0.1/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.18.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.18.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.17.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.17.1/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.16.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.15.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.15.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.14.3](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.14.3/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.13.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.12.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.11.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.10.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.9.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.8.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.7.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.7.1/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.6.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.5.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.4.0/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest)\n- [0.3.5](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.3.5/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest) \nReference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsRequest.\n\nThe request for\n[FirestoreAdmin.BulkDeleteDocuments](/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_bulk_delete_documents_instance_ \"Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#bulk_delete_documents (method)\").\n\n\nWhen both collection_ids and namespace_ids are set, only documents satisfying\nboth conditions will be deleted.\n\n\u003cbr /\u003e\n\nRequests with namespace_ids and collection_ids both empty will be rejected.\nPlease use\n[FirestoreAdmin.DeleteDatabase](/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_delete_database_instance_ \"Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#delete_database (method)\")\ninstead. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #collection_ids\n\n def collection_ids() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. IDs of the collection groups to delete. Unspecified means all collection groups.\n\n Each collection group in this list must be unique.\n\n### #collection_ids=\n\n def collection_ids=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- Optional. IDs of the collection groups to delete. Unspecified means all collection groups.\n\n\nEach collection group in this list must be unique. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. IDs of the collection groups to delete. Unspecified means all collection groups.\n\n Each collection group in this list must be unique.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Database to operate. Should be of the form: `projects/{project_id}/databases/{database_id}`.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. Database to operate. Should be of the form: `projects/{project_id}/databases/{database_id}`. \n**Returns**\n\n- (::String) --- Required. Database to operate. Should be of the form: `projects/{project_id}/databases/{database_id}`.\n\n### #namespace_ids\n\n def namespace_ids() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. Namespaces to delete.\n\n An empty list means all namespaces. This is the recommended\n usage for databases that don't use namespaces.\n\n An empty string element represents the default namespace. This should be\n used if the database has data in non-default namespaces, but doesn't want\n to delete from them.\n\n Each namespace in this list must be unique.\n\n### #namespace_ids=\n\n def namespace_ids=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- Optional. Namespaces to delete.\n\n\n An empty list means all namespaces. This is the recommended\n usage for databases that don't use namespaces.\n\n An empty string element represents the default namespace. This should be\n used if the database has data in non-default namespaces, but doesn't want\n to delete from them.\n\nEach namespace in this list must be unique. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. Namespaces to delete.\n\n An empty list means all namespaces. This is the recommended\n usage for databases that don't use namespaces.\n\n An empty string element represents the default namespace. This should be\n used if the database has data in non-default namespaces, but doesn't want\n to delete from them.\n\n Each namespace in this list must be unique."]]
