public sealed class DeleteDocumentRequest : IMessage<DeleteDocumentRequest>, IEquatable<DeleteDocumentRequest>, IDeepCloneable<DeleteDocumentRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1 API class DeleteDocumentRequest.
Request message for [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1.DocumentService.DeleteDocument] method.
Implements
IMessageDeleteDocumentRequest, IEquatableDeleteDocumentRequest, IDeepCloneableDeleteDocumentRequest, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
DeleteDocumentRequest()
public DeleteDocumentRequest()
DeleteDocumentRequest(DeleteDocumentRequest)
public DeleteDocumentRequest(DeleteDocumentRequest other)
Parameter | |
---|---|
Name | Description |
other |
DeleteDocumentRequest |
Properties
DocumentName
public DocumentName DocumentName { get; set; }
DocumentName-typed view over the Name resource name property.
Property Value | |
---|---|
Type | Description |
DocumentName |
Name
public string Name { get; set; }
Required. Full resource name of
[Document][google.cloud.discoveryengine.v1.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][google.cloud.discoveryengine.v1.Document], regardless of whether
or not it exists, a PERMISSION_DENIED
error is returned.
If the [Document][google.cloud.discoveryengine.v1.Document] to delete does
not exist, a NOT_FOUND
error is returned.
Property Value | |
---|---|
Type | Description |
string |