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

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
NameDescription
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
TypeDescription
int|string

setPurgeCount

The total count of documents purged as a result of the operation.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string[]
Returns
TypeDescription
$this