public virtual Task<Operation> PurgeDocuments(PurgeDocumentsRequest request, ServerCallContext context)
Permanently deletes all selected
[Document][google.cloud.discoveryengine.v1.Document]s in a branch.
This process is asynchronous. Depending on the number of
[Document][google.cloud.discoveryengine.v1.Document]s to be deleted, this
operation can take hours to complete. Before the delete operation
completes, some [Document][google.cloud.discoveryengine.v1.Document]s might
still be returned by
[DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument]
or
[DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments].
To get a list of the [Document][google.cloud.discoveryengine.v1.Document]s
to be deleted, set
[PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force]
to false.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eDocumentService.DocumentServiceBase\u003c/code\u003e class provides the base for server-side implementations of the DocumentService within the Google Cloud Discovery Engine v1 API, with the latest version being 1.6.0.\u003c/p\u003e\n"],["\u003cp\u003eThis API allows for managing documents, including creating, retrieving, deleting, updating, listing, and importing multiple documents in bulk.\u003c/p\u003e\n"],["\u003cp\u003eThe service includes methods for permanently deleting documents, with the ability to purge them from a branch asynchronously using \u003ccode\u003ePurgeDocuments\u003c/code\u003e, and retrieving document index freshness metadata via \u003ccode\u003eBatchGetDocumentsMetadata\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eEach method in \u003ccode\u003eDocumentService.DocumentServiceBase\u003c/code\u003e takes a specific request type and a \u003ccode\u003eServerCallContext\u003c/code\u003e, and returns a task containing the appropriate response object, allowing for server-side handling of document operations.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides methods for both individual document operations like \u003ccode\u003eGetDocument\u003c/code\u003e, \u003ccode\u003eCreateDocument\u003c/code\u003e, \u003ccode\u003eDeleteDocument\u003c/code\u003e and \u003ccode\u003eUpdateDocument\u003c/code\u003e, and batch operations such as \u003ccode\u003eImportDocuments\u003c/code\u003e and \u003ccode\u003ePurgeDocuments\u003c/code\u003e, enabling efficient management of document data.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1 API - Class DocumentService.DocumentServiceBase (1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.DocumentService.DocumentServiceBase)\n- [1.8.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.8.0/Google.Cloud.DiscoveryEngine.V1.DocumentService.DocumentServiceBase)\n- [1.7.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.7.0/Google.Cloud.DiscoveryEngine.V1.DocumentService.DocumentServiceBase)\n- [1.6.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.6.0/Google.Cloud.DiscoveryEngine.V1.DocumentService.DocumentServiceBase)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.5.0/Google.Cloud.DiscoveryEngine.V1.DocumentService.DocumentServiceBase)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.4.0/Google.Cloud.DiscoveryEngine.V1.DocumentService.DocumentServiceBase)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.3.0/Google.Cloud.DiscoveryEngine.V1.DocumentService.DocumentServiceBase)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.2.0/Google.Cloud.DiscoveryEngine.V1.DocumentService.DocumentServiceBase)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.1.0/Google.Cloud.DiscoveryEngine.V1.DocumentService.DocumentServiceBase)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.0.0-beta06/Google.Cloud.DiscoveryEngine.V1.DocumentService.DocumentServiceBase) \n\n [BindServiceMethod(typeof(DocumentService), \"BindService\")]\n public abstract class DocumentService.DocumentServiceBase\n\nReference documentation and code samples for the Discovery Engine v1 API class DocumentService.DocumentServiceBase.\n\nBase class for server-side implementations of DocumentService \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e DocumentService.DocumentServiceBase \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.DiscoveryEngine.V1](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1.dll\n\nMethods\n-------\n\n### BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest, ServerCallContext)\n\n public virtual Task\u003cBatchGetDocumentsMetadataResponse\u003e BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request, ServerCallContext context)\n\nGets index freshness metadata for\n\\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\]s. Supported for\nwebsite search only.\n\n### CreateDocument(CreateDocumentRequest, ServerCallContext)\n\n public virtual Task\u003cDocument\u003e CreateDocument(CreateDocumentRequest request, ServerCallContext context)\n\nCreates a \\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\].\n\n### DeleteDocument(DeleteDocumentRequest, ServerCallContext)\n\n public virtual Task\u003cEmpty\u003e DeleteDocument(DeleteDocumentRequest request, ServerCallContext context)\n\nDeletes a \\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\].\n\n### GetDocument(GetDocumentRequest, ServerCallContext)\n\n public virtual Task\u003cDocument\u003e GetDocument(GetDocumentRequest request, ServerCallContext context)\n\nGets a \\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\].\n\n### ImportDocuments(ImportDocumentsRequest, ServerCallContext)\n\n public virtual Task\u003cOperation\u003e ImportDocuments(ImportDocumentsRequest request, ServerCallContext context)\n\nBulk import of multiple\n\\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\]s. Request processing\nmay be synchronous. Non-existing items are created.\n\nNote: It is possible for a subset of the\n\\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\]s to be successfully\nupdated.\n\n### ListDocuments(ListDocumentsRequest, ServerCallContext)\n\n public virtual Task\u003cListDocumentsResponse\u003e ListDocuments(ListDocumentsRequest request, ServerCallContext context)\n\nGets a list of \\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\]s.\n\n### PurgeDocuments(PurgeDocumentsRequest, ServerCallContext)\n\n public virtual Task\u003cOperation\u003e PurgeDocuments(PurgeDocumentsRequest request, ServerCallContext context)\n\nPermanently deletes all selected\n\\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\]s in a branch.\n\nThis process is asynchronous. Depending on the number of\n\\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\]s to be deleted, this\noperation can take hours to complete. Before the delete operation\ncompletes, some \\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\]s might\nstill be returned by\n\\[DocumentService.GetDocument\\]\\[google.cloud.discoveryengine.v1.DocumentService.GetDocument\\]\nor\n\\[DocumentService.ListDocuments\\]\\[google.cloud.discoveryengine.v1.DocumentService.ListDocuments\\].\n\nTo get a list of the \\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\]s\nto be deleted, set\n\\[PurgeDocumentsRequest.force\\]\\[google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force\\]\nto false.\n\n### UpdateDocument(UpdateDocumentRequest, ServerCallContext)\n\n public virtual Task\u003cDocument\u003e UpdateDocument(UpdateDocumentRequest request, ServerCallContext context)\n\nUpdates a \\[Document\\]\\[google.cloud.discoveryengine.v1.Document\\]."]]
