Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsRequest (v1.1.0)

Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsRequest.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#collection_ids

def collection_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=

def collection_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

def name() -> ::String
Returns
  • (::String) — Required. Database to operate. Should be of the form: projects/{project_id}/databases/{database_id}.

#name=

def name=(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

def namespace_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=

def namespace_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.

    Each namespace in this list must be unique.