Method: projects.locations.collections.dataStores.branches.documents.delete
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
DELETE https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.
|
Request body
The request body must be empty.
Response body
If successful, the response body is an empty JSON object.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name resource:
discoveryengine.documents.delete
For more information, see the IAM documentation.
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 2025-03-03 UTC.
[[["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-03-03 UTC."],[[["This endpoint facilitates the deletion of a specific Document resource identified by its full resource name within a project, location, collection, data store, and branch."],["The HTTP request utilizes a `DELETE` method to a predefined URL structure, following gRPC Transcoding syntax, for initiating the document deletion process."],["The deletion operation requires the caller to have the `discoveryengine.documents.delete` IAM permission on the specified document resource, or else a `PERMISSION_DENIED` error is returned."],["The request body must be empty for this `DELETE` operation, and a successful deletion will return an empty JSON object as the response body."],["To authorize this request, the OAuth scope `https://www.googleapis.com/auth/cloud-platform` is mandatory."]]],[]]
