Class PurgeDocumentsRequest (0.7.0)

PurgeDocumentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for DocumentService.PurgeDocuments method.


parent str
Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
filter str
Required. Filter matching documents to purge. Only currently supported value is * (all items).
force bool
Actually performs the purge. If force is set to false, return the expected purge count without deleting any documents.