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 document provides reference information for the \u003ccode\u003ePurgeDocumentsResponse\u003c/code\u003e class within the Google Cloud Discovery Engine v1 API.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePurgeDocumentsResponse\u003c/code\u003e class is used to represent the response received after successfully completing a \u003ccode\u003ePurgeDocuments\u003c/code\u003e operation.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the \u003ccode\u003ePurgeDocumentsResponse\u003c/code\u003e is version 1.6.0, but several older versions, including betas, are also documented.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003ePurgeDocumentsResponse\u003c/code\u003e include \u003ccode\u003ePurgeCount\u003c/code\u003e, indicating the number of purged documents, and \u003ccode\u003ePurgeSample\u003c/code\u003e, providing a sample of document names to be deleted if force was not set.\u003c/p\u003e\n"],["\u003cp\u003eThis class inherits from \u003ccode\u003eobject\u003c/code\u003e and implements multiple interfaces such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e for various functionalities.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1 API - Class PurgeDocumentsResponse (1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsResponse)\n- [1.8.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.8.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsResponse)\n- [1.7.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.7.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsResponse)\n- [1.6.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.6.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsResponse)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.5.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsResponse)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.4.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsResponse)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.3.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsResponse)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.2.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsResponse)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.1.0/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsResponse)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.0.0-beta06/Google.Cloud.DiscoveryEngine.V1.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 v1 API class PurgeDocumentsResponse.\n\nResponse message for\n\\[DocumentService.PurgeDocuments\\]\\[google.cloud.discoveryengine.v1.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.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsResponse), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[PurgeDocumentsResponse](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsResponse), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[PurgeDocumentsResponse](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.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.V1](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1.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.V1/latest/Google.Cloud.DiscoveryEngine.V1.DocumentName)-typed view over the [PurgeSample](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeDocumentsResponse#Google_Cloud_DiscoveryEngine_V1_PurgeDocumentsResponse_PurgeSample) resource name property."]]
