Reference documentation and code samples for the Cloud Firestore V1 Client class DeleteDocumentRequest.
The request for Firestore.DeleteDocument .
Generated from protobuf message google.firestore.v1.DeleteDocumentRequest
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}
.
↳ current_document
Google\Cloud\Firestore\V1\Precondition
An optional precondition on the document. The request will fail if this is set and not met by the target document.
getName
Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}
.
string
setName
Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}
.
var
string
$this
getCurrentDocument
An optional precondition on the document.
The request will fail if this is set and not met by the target document.
hasCurrentDocument
clearCurrentDocument
setCurrentDocument
An optional precondition on the document.
The request will fail if this is set and not met by the target document.
$this
static::build
name
string
Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}
.
