Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class PurgeDocumentsResponse.
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.
Generated from protobuf message google.cloud.discoveryengine.v1.PurgeDocumentsResponse
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ purge_count
int|string
The total count of documents purged as a result of the operation.
↳ purge_sample
array
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.
getPurgeCount
The total count of documents purged as a result of the operation.
Returns
Type
Description
int|string
setPurgeCount
The total count of documents purged as a result of the operation.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getPurgeSample
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.
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-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class PurgeDocumentsResponse (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.PurgeDocumentsResponse)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.PurgeDocumentsResponse)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.PurgeDocumentsResponse)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.PurgeDocumentsResponse)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.PurgeDocumentsResponse)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.PurgeDocumentsResponse)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.PurgeDocumentsResponse)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.PurgeDocumentsResponse)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.PurgeDocumentsResponse)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.PurgeDocumentsResponse)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.PurgeDocumentsResponse)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.PurgeDocumentsResponse)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.PurgeDocumentsResponse)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.PurgeDocumentsResponse)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.PurgeDocumentsResponse)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.PurgeDocumentsResponse)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.PurgeDocumentsResponse) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class PurgeDocumentsResponse.\n\nResponse message for\n[DocumentService.PurgeDocuments](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.DocumentServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_DocumentServiceClient__purgeDocuments__)\nmethod. If the long running operation is successfully done, then this message\nis returned by the google.longrunning.Operations.response field.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.PurgeDocumentsResponse`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPurgeCount\n\nThe total count of documents purged as a result of the operation.\n\n### setPurgeCount\n\nThe total count of documents purged as a result of the operation.\n\n### getPurgeSample\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### setPurgeSample\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."]]
