Class ProjectsResource.DatabasesResource.BulkDeleteDocumentsRequest

Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created. For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleLongrunningOperation>
FirestoreBaseServiceRequest<GoogleLongrunningOperation>
ProjectsResource.DatabasesResource.BulkDeleteDocumentsRequest
Implements
Inherited Members
Namespace: Google.Apis.Firestore.v1
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class ProjectsResource.DatabasesResource.BulkDeleteDocumentsRequest : FirestoreBaseServiceRequest<GoogleLongrunningOperation>, IClientServiceRequest<GoogleLongrunningOperation>, IClientServiceRequest

Constructors

BulkDeleteDocumentsRequest(IClientService, GoogleFirestoreAdminV1BulkDeleteDocumentsRequest, string)

Constructs a new BulkDeleteDocuments request.

Declaration
public BulkDeleteDocumentsRequest(IClientService service, GoogleFirestoreAdminV1BulkDeleteDocumentsRequest body, string name)
Parameters
Type Name Description
IClientService service
GoogleFirestoreAdminV1BulkDeleteDocumentsRequest body
string name

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Name

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

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes BulkDeleteDocuments parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements