Class: Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/admin/v1/firestore_admin.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#collection_ids ⇒ ::Array<::String>

Returns 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.



458
459
460
461
 
# File 'proto_docs/google/firestore/admin/v1/firestore_admin.rb', line 458

class BulkDeleteDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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}.



458
459
460
461
 
# File 'proto_docs/google/firestore/admin/v1/firestore_admin.rb', line 458

class BulkDeleteDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#namespace_ids ⇒ ::Array<::String>

Returns 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.



458
459
460
461
 
# File 'proto_docs/google/firestore/admin/v1/firestore_admin.rb', line 458

class BulkDeleteDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end