Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
↳ filter
string
Required. Filter matching documents to purge. Only currently supported value is * (all items).
Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Returns
Type
Description
string
setParent
Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Required. Filter matching documents to purge. Only currently supported
value is
* (all items).
Returns
Type
Description
string
setFilter
Required. Filter matching documents to purge. Only currently supported
value is
* (all items).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getErrorConfig
The desired location of errors incurred during the purge.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class PurgeDocumentsRequest (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.PurgeDocumentsRequest)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.PurgeDocumentsRequest)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.PurgeDocumentsRequest)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.PurgeDocumentsRequest)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.PurgeDocumentsRequest)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.PurgeDocumentsRequest)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.PurgeDocumentsRequest)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.PurgeDocumentsRequest)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.PurgeDocumentsRequest)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.PurgeDocumentsRequest)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.PurgeDocumentsRequest)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.PurgeDocumentsRequest)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.PurgeDocumentsRequest)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.PurgeDocumentsRequest)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.PurgeDocumentsRequest)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.PurgeDocumentsRequest)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.PurgeDocumentsRequest) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class PurgeDocumentsRequest.\n\nRequest message for\n[DocumentService.PurgeDocuments](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.DocumentServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_DocumentServiceClient__purgeDocuments__)\nmethod.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.PurgeDocumentsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getGcsSource\n\nCloud Storage location for the input content.\n\nSupported `data_schema`:\n\n- `document_id`: One valid [Document.id](/php/docs/reference/cloud-discoveryengine/latest/V1.Document#_Google_Cloud_DiscoveryEngine_V1_Document__getId__) per line.\n\n### hasGcsSource\n\n### setGcsSource\n\nCloud Storage location for the input content.\n\nSupported `data_schema`:\n\n- `document_id`: One valid [Document.id](/php/docs/reference/cloud-discoveryengine/latest/V1.Document#_Google_Cloud_DiscoveryEngine_V1_Document__getId__) per line.\n\n### getInlineSource\n\nInline source for the input content for purge.\n\n### hasInlineSource\n\n### setInlineSource\n\nInline source for the input content for purge.\n\n### getParent\n\nRequired. The parent resource name, such as\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.\n\n### setParent\n\nRequired. The parent resource name, such as\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.\n\n### getFilter\n\nRequired. Filter matching documents to purge. Only currently supported\nvalue is\n`*` (all items).\n\n### setFilter\n\nRequired. Filter matching documents to purge. Only currently supported\nvalue is\n`*` (all items).\n\n### getErrorConfig\n\nThe desired location of errors incurred during the purge.\n\n### hasErrorConfig\n\n### clearErrorConfig\n\n### setErrorConfig\n\nThe desired location of errors incurred during the purge.\n\n### getForce\n\nActually performs the purge. If `force` is set to false, return the\nexpected purge count without deleting any documents.\n\n### setForce\n\nActually performs the purge. If `force` is set to false, return the\nexpected purge count without deleting any documents.\n\n### getSource"]]
