PurgeDocumentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request message for DocumentService.PurgeDocuments method.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _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.
|
inline_source |
google.cloud.discoveryengine_v1alpha.types.PurgeDocumentsRequest.InlineSource
Inline source for the input content for purge. 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.
|
Classes
InlineSource
InlineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)The inline source for the input config for DocumentService.PurgeDocuments method.