Generated from protobuf messagegoogle.cloud.discoveryengine.v1.DeleteDocumentRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. Full resource name ofDocument, such asprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}. If the caller does not have permission to delete theDocument, regardless of whether or not it exists, aPERMISSION_DENIEDerror is returned. If theDocumentto delete does not exist, aNOT_FOUNDerror is returned.
getName
Required. Full resource name ofDocument, such asprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.
If the caller does not have permission to delete theDocument, regardless of whether
or not it exists, aPERMISSION_DENIEDerror is returned.
If theDocumentto delete does
not exist, aNOT_FOUNDerror is returned.
Returns
Type
Description
string
setName
Required. Full resource name ofDocument, such asprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.
If the caller does not have permission to delete theDocument, regardless of whether
or not it exists, aPERMISSION_DENIEDerror is returned.
If theDocumentto delete does
not exist, aNOT_FOUNDerror is returned.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. Full resource name ofDocument, such asprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.
If the caller does not have permission to delete theDocument, regardless of whether
or not it exists, aPERMISSION_DENIEDerror is returned.
If theDocumentto delete does
not exist, aNOT_FOUNDerror is returned. Please seeDocumentServiceClient::documentName()for help formatting this field.
[[["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 DeleteDocumentRequest (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.DeleteDocumentRequest)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.DeleteDocumentRequest)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.DeleteDocumentRequest)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.DeleteDocumentRequest)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.DeleteDocumentRequest)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.DeleteDocumentRequest)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.DeleteDocumentRequest)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.DeleteDocumentRequest)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.DeleteDocumentRequest)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.DeleteDocumentRequest)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.DeleteDocumentRequest)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.DeleteDocumentRequest)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.DeleteDocumentRequest)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.DeleteDocumentRequest)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.DeleteDocumentRequest)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.DeleteDocumentRequest)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.DeleteDocumentRequest) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DeleteDocumentRequest.\n\nRequest message for\n[DocumentService.DeleteDocument](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.DocumentServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_DocumentServiceClient__deleteDocument__)\nmethod.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.DeleteDocumentRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. Full resource name of\n[Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document), such as\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.\n\nIf the caller does not have permission to delete the\n[Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document), regardless of whether\nor not it exists, a `PERMISSION_DENIED` error is returned.\nIf the [Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document) to delete does\nnot exist, a `NOT_FOUND` error is returned.\n\n### setName\n\nRequired. Full resource name of\n[Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document), such as\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.\n\nIf the caller does not have permission to delete the\n[Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document), regardless of whether\nor not it exists, a `PERMISSION_DENIED` error is returned.\nIf the [Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document) to delete does\nnot exist, a `NOT_FOUND` error is returned.\n\n### static::build"]]
