public sealed class DeleteDocumentRequest : IMessage<DeleteDocumentRequest>, IEquatable<DeleteDocumentRequest>, IDeepCloneable<DeleteDocumentRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Firestore v1 API class DeleteDocumentRequest.
The request for [Firestore.DeleteDocument][google.firestore.v1.Firestore.DeleteDocument].
Implements
IMessageDeleteDocumentRequest, IEquatableDeleteDocumentRequest, IDeepCloneableDeleteDocumentRequest, IBufferMessage, IMessageNamespace
GoogleCloudGoogle.Cloud.FirestoreV1Assembly
Google.Cloud.Firestore.V1.dll
Constructors
DeleteDocumentRequest()
public DeleteDocumentRequest()
DeleteDocumentRequest(DeleteDocumentRequest)
public DeleteDocumentRequest(DeleteDocumentRequest other)
Parameter | |
---|---|
Name | Description |
other | DeleteDocumentRequest |
Properties
CurrentDocument
public Precondition CurrentDocument { get; set; }
An optional precondition on the document. The request will fail if this is set and not met by the target document.
Property Value | |
---|---|
Type | Description |
Precondition |
Name
public string Name { get; set; }
Required. The resource name of the Document to delete. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
Property Value | |
---|---|
Type | Description |
string |