public sealed class PurgeDocumentsRequest : IMessage<PurgeDocumentsRequest>, IEquatable<PurgeDocumentsRequest>, IDeepCloneable<PurgeDocumentsRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1 API class PurgeDocumentsRequest.
Request message for
[DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments]
method.
Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThis document provides reference information for the \u003ccode\u003ePurgeDocumentsRequest\u003c/code\u003e class within the Google Cloud Discovery Engine v1 API.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePurgeDocumentsRequest\u003c/code\u003e class is used to send requests for the \u003ccode\u003eDocumentService.PurgeDocuments\u003c/code\u003e method, which is used to delete documents.\u003c/p\u003e\n"],["\u003cp\u003eThe class implements several interfaces including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and inherits from \u003ccode\u003eobject\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003ePurgeDocumentsRequest\u003c/code\u003e include \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForce\u003c/code\u003e, \u003ccode\u003eGcsSource\u003c/code\u003e, \u003ccode\u003eInlineSource\u003c/code\u003e, and \u003ccode\u003eParent\u003c/code\u003e, which configure how the document purge is conducted.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the API is 1.6.0, and older versions are available, such as 1.5.0, 1.4.0, 1.3.0, 1.2.0, 1.1.0, and 1.0.0-beta06.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1 API - Class PurgeDocumentsRequest (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.PurgeDocumentsRequest)\n- [1.8.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.8.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest)\n- [1.7.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.7.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest)\n- [1.6.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.6.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.5.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.4.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.3.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.2.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.1.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.0.0-beta06/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest) \n\n public sealed class PurgeDocumentsRequest : IMessage\u003cPurgeDocumentsRequest\u003e, IEquatable\u003cPurgeDocumentsRequest\u003e, IDeepCloneable\u003cPurgeDocumentsRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Discovery Engine v1 API class PurgeDocumentsRequest.\n\nRequest message for\n\\[DocumentService.PurgeDocuments\\]\\[google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments\\]\nmethod. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e PurgeDocumentsRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[PurgeDocumentsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[PurgeDocumentsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[PurgeDocumentsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \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.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\nConstructors\n------------\n\n### PurgeDocumentsRequest()\n\n public PurgeDocumentsRequest()\n\n### PurgeDocumentsRequest(PurgeDocumentsRequest)\n\n public PurgeDocumentsRequest(PurgeDocumentsRequest other)\n\nProperties\n----------\n\n### ErrorConfig\n\n public PurgeErrorConfig ErrorConfig { get; set; }\n\nThe desired location of errors incurred during the purge.\n\n### Filter\n\n public string Filter { get; set; }\n\nRequired. Filter matching documents to purge. Only currently supported\nvalue is\n`*` (all items).\n\n### Force\n\n public bool Force { get; set; }\n\nActually performs the purge. If `force` is set to false, return the\nexpected purge count without deleting any documents.\n\n### GcsSource\n\n public GcsSource GcsSource { get; set; }\n\nCloud Storage location for the input content.\nSupported `data_schema`:\n\n- `document_id`: One valid \\[Document.id\\]\\[google.cloud.discoveryengine.v1.Document.id\\] per line.\n\n### InlineSource\n\n public PurgeDocumentsRequest.Types.InlineSource InlineSource { get; set; }\n\nInline source for the input content for purge.\n\n### Parent\n\n public string Parent { get; set; }\n\nRequired. The parent resource name, such as\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.\n\n### ParentAsBranchName\n\n public BranchName ParentAsBranchName { get; set; }\n\n[BranchName](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.BranchName)-typed view over the [Parent](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsRequest#Google_Cloud_DiscoveryEngine_V1_PurgeDocumentsRequest_Parent) resource name property.\n\n### SourceCase\n\n public PurgeDocumentsRequest.SourceOneofCase SourceCase { get; }"]]
