Google Cloud Retail V2 Client - Class PurgeProductsResponse (2.3.1)

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setPurgeSample