public sealed class PurgeDocumentsResponse : IMessage<PurgeDocumentsResponse>, IEquatable<PurgeDocumentsResponse>, IDeepCloneable<PurgeDocumentsResponse>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1beta API class PurgeDocumentsResponse.
Response message for
[DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.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"]],[["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-07 UTC."],[[["\u003cp\u003eThis documentation is for the \u003ccode\u003ePurgeDocumentsResponse\u003c/code\u003e class within the Google Cloud Discovery Engine v1beta API, specifically version 1.0.0-beta18.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePurgeDocumentsResponse\u003c/code\u003e is the response message for the \u003ccode\u003eDocumentService.PurgeDocuments\u003c/code\u003e method, returned upon successful completion of a long-running operation.\u003c/p\u003e\n"],["\u003cp\u003eThe class includes properties such as \u003ccode\u003ePurgeCount\u003c/code\u003e, which indicates the number of documents purged, and \u003ccode\u003ePurgeSample\u003c/code\u003e, which provides a sample of document names that will be deleted.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePurgeDocumentsResponse\u003c/code\u003e 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\u003eThere are two constructors available for \u003ccode\u003ePurgeDocumentsResponse\u003c/code\u003e, one is a parameterless constructor and the other one takes another \u003ccode\u003ePurgeDocumentsResponse\u003c/code\u003e object as a parameter.\u003c/p\u003e\n"]]],[],null,[]]