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"]],[["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\u003eThis page provides documentation for the \u003ccode\u003ePurgeDocumentsRequest\u003c/code\u003e class within the Google Cloud Discovery Engine v1 API, specifically version 1.4.0, and details the request message structure for the \u003ccode\u003eDocumentService.PurgeDocuments\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePurgeDocumentsRequest\u003c/code\u003e class, which inherits from \u003ccode\u003eobject\u003c/code\u003e, allows for the deletion of documents and implements multiple interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003ePurgeDocumentsRequest\u003c/code\u003e include \u003ccode\u003eFilter\u003c/code\u003e (for matching documents to purge), \u003ccode\u003eForce\u003c/code\u003e (to control whether to actually delete documents), \u003ccode\u003eErrorConfig\u003c/code\u003e (for error location), \u003ccode\u003eGcsSource\u003c/code\u003e (Cloud Storage location), \u003ccode\u003eInlineSource\u003c/code\u003e (inline content for purge) and \u003ccode\u003eParent\u003c/code\u003e (parent resource name).\u003c/p\u003e\n"],["\u003cp\u003eThere are multiple versions of this API available, with the latest version being 1.6.0, and this page specifically documents version 1.4.0, and is implemented in the \u003ccode\u003eGoogle.Cloud.DiscoveryEngine.V1\u003c/code\u003e namespace within the \u003ccode\u003eGoogle.Cloud.DiscoveryEngine.V1.dll\u003c/code\u003e assembly.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePurgeDocumentsRequest\u003c/code\u003e class has two constructors, one that takes no arguments and another that takes another \u003ccode\u003ePurgeDocumentsRequest\u003c/code\u003e object, and also includes properties for specifying the purge source via \u003ccode\u003eSourceCase\u003c/code\u003e, which can be set by \u003ccode\u003eGcsSource\u003c/code\u003e or \u003ccode\u003eInlineSource\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]
