Reference documentation and code samples for the Google Cloud Retail V2 Client class PurgeProductsResponse.
Response of the PurgeProductsRequest. 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.retail.v2.PurgeProductsResponse
Namespace
Google \ Cloud \ Retail \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ purge_count
int|string
The total count of products purged as a result of the operation.
↳ purge_sample
array
A sample of the product 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 products purged as a result of the operation.
Returns
Type
Description
int|string
setPurgeCount
The total count of products purged as a result of the operation.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getPurgeSample
A sample of the product 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-28 UTC."],[],[],null,["# Google Cloud Retail V2 Client - Class PurgeProductsResponse (2.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.1 (latest)](/php/docs/reference/cloud-retail/latest/V2.PurgeProductsResponse)\n- [2.3.0](/php/docs/reference/cloud-retail/2.3.0/V2.PurgeProductsResponse)\n- [2.2.1](/php/docs/reference/cloud-retail/2.2.1/V2.PurgeProductsResponse)\n- [2.1.3](/php/docs/reference/cloud-retail/2.1.3/V2.PurgeProductsResponse)\n- [2.0.0](/php/docs/reference/cloud-retail/2.0.0/V2.PurgeProductsResponse)\n- [1.7.0](/php/docs/reference/cloud-retail/1.7.0/V2.PurgeProductsResponse)\n- [1.6.4](/php/docs/reference/cloud-retail/1.6.4/V2.PurgeProductsResponse)\n- [1.5.0](/php/docs/reference/cloud-retail/1.5.0/V2.PurgeProductsResponse)\n- [1.4.2](/php/docs/reference/cloud-retail/1.4.2/V2.PurgeProductsResponse)\n- [1.3.1](/php/docs/reference/cloud-retail/1.3.1/V2.PurgeProductsResponse)\n- [1.2.1](/php/docs/reference/cloud-retail/1.2.1/V2.PurgeProductsResponse)\n- [1.1.1](/php/docs/reference/cloud-retail/1.1.1/V2.PurgeProductsResponse)\n- [1.0.1](/php/docs/reference/cloud-retail/1.0.1/V2.PurgeProductsResponse) \nReference documentation and code samples for the Google Cloud Retail V2 Client class PurgeProductsResponse.\n\nResponse of the PurgeProductsRequest. If the long running operation is\nsuccessfully done, then this message is returned by the\ngoogle.longrunning.Operations.response field.\n\nGenerated from protobuf message `google.cloud.retail.v2.PurgeProductsResponse`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Retail \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPurgeCount\n\nThe total count of products purged as a result of the operation.\n\n### setPurgeCount\n\nThe total count of products purged as a result of the operation.\n\n### getPurgeSample\n\nA sample of the product names that will be deleted.\n\nOnly populated if `force` is set to false. A max of 100 names will be\nreturned and the names are chosen at random.\n\n### setPurgeSample\n\nA sample of the product names that will be deleted.\n\nOnly populated if `force` is set to false. A max of 100 names will be\nreturned and the names are chosen at random."]]
