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\u003eThe latest version of the \u003ccode\u003ePurgeDocumentsRequest\u003c/code\u003e class is 1.6.0, part of the Discovery Engine v1 API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePurgeDocumentsRequest\u003c/code\u003e is a request message used with the \u003ccode\u003eDocumentService.PurgeDocuments\u003c/code\u003e method for managing document deletion.\u003c/p\u003e\n"],["\u003cp\u003eThis class inherits from \u003ccode\u003eobject\u003c/code\u003e and 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.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003ePurgeDocumentsRequest\u003c/code\u003e include \u003ccode\u003eFilter\u003c/code\u003e to specify which documents to purge, \u003ccode\u003eForce\u003c/code\u003e to control whether the purge is executed or just simulated, and \u003ccode\u003eParent\u003c/code\u003e to identify the parent resource.\u003c/p\u003e\n"],["\u003cp\u003eThe class also includes a method for a strongly typed view over the \u003ccode\u003eParent\u003c/code\u003e resource called \u003ccode\u003eParentAsBranchName\u003c/code\u003e, and a constructor that can take another \u003ccode\u003ePurgeDocumentsRequest\u003c/code\u003e object as a parameter.\u003c/p\u003e\n"]]],[],null,[]]
