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"]],[["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 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,["# Discovery Engine v1beta API - Class PurgeDocumentsResponse (1.0.0-beta19)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta19 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeDocumentsResponse)\n- [1.0.0-beta18](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/1.0.0-beta18/Google.Cloud.DiscoveryEngine.V1Beta.PurgeDocumentsResponse) \n\n public sealed class PurgeDocumentsResponse : IMessage\u003cPurgeDocumentsResponse\u003e, IEquatable\u003cPurgeDocumentsResponse\u003e, IDeepCloneable\u003cPurgeDocumentsResponse\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Discovery Engine v1beta API class PurgeDocumentsResponse.\n\nResponse message for\n\\[DocumentService.PurgeDocuments\\]\\[google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments\\]\nmethod. If the long running operation is successfully done, then this message\nis returned by the google.longrunning.Operations.response field. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e PurgeDocumentsResponse \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[PurgeDocumentsResponse](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeDocumentsResponse), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[PurgeDocumentsResponse](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeDocumentsResponse), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[PurgeDocumentsResponse](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeDocumentsResponse), [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.V1Beta](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1Beta.dll\n\nConstructors\n------------\n\n### PurgeDocumentsResponse()\n\n public PurgeDocumentsResponse()\n\n### PurgeDocumentsResponse(PurgeDocumentsResponse)\n\n public PurgeDocumentsResponse(PurgeDocumentsResponse other)\n\nProperties\n----------\n\n### PurgeCount\n\n public long PurgeCount { get; set; }\n\nThe total count of documents purged as a result of the operation.\n\n### PurgeSample\n\n public RepeatedField\u003cstring\u003e PurgeSample { get; }\n\nA sample of document names that will be deleted. Only populated if `force`\nis set to false. A max of 100 names will be returned and the names are\nchosen at random.\n\n### PurgeSampleAsDocumentNames\n\n public ResourceNameList\u003cDocumentName\u003e PurgeSampleAsDocumentNames { get; }\n\n[DocumentName](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.DocumentName)-typed view over the [PurgeSample](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeDocumentsResponse#Google_Cloud_DiscoveryEngine_V1Beta_PurgeDocumentsResponse_PurgeSample) resource name property."]]
