Discovery Engine v1beta API - Class DeleteDocumentRequest (1.0.0-beta12)

Version latest

• 1.0.0-beta12 (latest)
• 1.0.0-beta11

public sealed class DeleteDocumentRequest : IMessage<DeleteDocumentRequest>, IEquatable<DeleteDocumentRequest>, IDeepCloneable<DeleteDocumentRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1beta API class DeleteDocumentRequest.

Request message for [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1beta.DocumentService.DeleteDocument] method.

Inheritance

object > DeleteDocumentRequest

Implements

IMessageDeleteDocumentRequest, IEquatableDeleteDocumentRequest, IDeepCloneableDeleteDocumentRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.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.v1beta.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.v1beta.Document], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [Document][google.cloud.discoveryengine.v1beta.Document] to delete does not exist, a NOT_FOUND error is returned.

Property Value
Type	Description
string