public sealed class PurgeDocumentsResponse : IMessage<PurgeDocumentsResponse>, IEquatable<PurgeDocumentsResponse>, IDeepCloneable<PurgeDocumentsResponse>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1 API class PurgeDocumentsResponse.
Response message for
[DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments]
method. If the long running operation is successfully done, then this message
is returned by the google.longrunning.Operations.response field.
A sample of document names that will be deleted. Only populated if force
is set to false. A max of 100 names will be returned and the names are
chosen at random.
[[["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\u003ePurgeDocumentsResponse\u003c/code\u003e class within the Google Cloud Discovery Engine v1 API, specifically version 1.3.0, with links to other versions as well.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePurgeDocumentsResponse\u003c/code\u003e class is a response message for the \u003ccode\u003eDocumentService.PurgeDocuments\u003c/code\u003e method and returns when the long-running operation is complete.\u003c/p\u003e\n"],["\u003cp\u003eThis class inherits from \u003ccode\u003eobject\u003c/code\u003e and implements 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\u003eIt contains properties like \u003ccode\u003ePurgeCount\u003c/code\u003e, which is the total number of documents deleted, and \u003ccode\u003ePurgeSample\u003c/code\u003e, which provides a sample list of document names scheduled for deletion when \u003ccode\u003eforce\u003c/code\u003e is set to false.\u003c/p\u003e\n"],["\u003cp\u003eIt contains a constructor that allows the creation of a new \u003ccode\u003ePurgeDocumentsResponse\u003c/code\u003e object, and a second constructor that allows the replication of an already existing \u003ccode\u003ePurgeDocumentsResponse\u003c/code\u003e object.\u003c/p\u003e\n"]]],[],null,[]]
