Google Cloud Discovery Engine V1 Client - Class PurgeDocumentsResponse (1.3.2)

Version latest

• 1.3.2 (latest)
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setPurgeSample

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.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this