Cloud Firestore V1 Client - Class BulkDeleteDocumentsRequest (1.45.0)

Version 1.45.0

• 1.47.1 (latest)
• 1.47.0
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

Reference documentation and code samples for the Cloud Firestore V1 Client class 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.

Generated from protobuf message google.firestore.admin.v1.BulkDeleteDocumentsRequest

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. Database to operate. Should be of the form: projects/{project_id}/databases/{database_id}.
↳ collection_ids	array Optional. IDs of the collection groups to delete. Unspecified means all collection groups. Each collection group in this list must be unique.
↳ namespace_ids	array 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.

getName

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

Returns
Type	Description
string

setName

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCollectionIds

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

Each collection group in this list must be unique.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setCollectionIds

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

Each collection group in this list must be unique.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getNamespaceIds

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
Type	Description
Google\Protobuf\Internal\RepeatedField

setNamespaceIds

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.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

static::build

Parameter
Name	Description
name	string Required. Database to operate. Should be of the form: projects/{project_id}/databases/{database_id}. Please see Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::databaseName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Firestore\Admin\V1\BulkDeleteDocumentsRequest