Class PurgeDocumentsRequest (0.12.0)

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

Request message for DocumentService.PurgeDocuments method.

Attributes
Name	Description
`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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-19 UTC.

Attributes