Class PurgeDocumentsRequest (0.11.14)

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

Request message for DocumentService.PurgeDocuments method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
gcs_source google.cloud.discoveryengine_v1alpha.types.GcsSource
Cloud Storage location for the input content. Supported data_schema: - document_id: One valid Document.id per line. This field is a member of oneof_ source.
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).
error_config google.cloud.discoveryengine_v1alpha.types.PurgeErrorConfig
The desired location of errors incurred during the purge.
force bool
Actually performs the purge. If force is set to false, return the expected purge count without deleting any documents.