Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DeleteDocumentRequest.
Request message for DocumentService.DeleteDocument method.
Generated from protobuf message google.cloud.discoveryengine.v1.DeleteDocumentRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Full resource name of Document, such as |
getName
Required. Full resource name of
Document, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/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.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. Full resource name of
Document, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. Full resource name of
Document, such as
If the caller does not have permission to delete the
Document, regardless of whether
or not it exists, a If the Document to delete does
not exist, a |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\DeleteDocumentRequest | |