Response message for
DocumentService.PurgeDocuments
method. If the long running operation is successfully done, then
this message is returned by the
google.longrunning.Operations.response field.
Attributes
Name
Description
purge_count
int
The total count of documents purged as a
result of the operation.
purge_sample
MutableSequence[str]
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."],[],[],null,["# Class PurgeDocumentsResponse (0.13.11)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.11 (latest)](/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.13.10](/python/docs/reference/discoveryengine/0.13.10/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.12.3](/python/docs/reference/discoveryengine/0.12.3/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.11.14](/python/docs/reference/discoveryengine/0.11.14/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.10.0](/python/docs/reference/discoveryengine/0.10.0/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.9.1](/python/docs/reference/discoveryengine/0.9.1/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.8.1](/python/docs/reference/discoveryengine/0.8.1/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.7.0](/python/docs/reference/discoveryengine/0.7.0/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.6.0](/python/docs/reference/discoveryengine/0.6.0/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.5.0](/python/docs/reference/discoveryengine/0.5.0/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.4.1](/python/docs/reference/discoveryengine/0.4.1/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.3.1](/python/docs/reference/discoveryengine/0.3.1/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.2.1](/python/docs/reference/discoveryengine/0.2.1/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse)\n- [0.1.1](/python/docs/reference/discoveryengine/0.1.1/google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse) \n\n PurgeDocumentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nResponse message for\nDocumentService.PurgeDocuments\nmethod. If the long running operation is successfully done, then\nthis message is returned by the\ngoogle.longrunning.Operations.response field."]]
