Cloud Firestore V1 Client - Class DeleteDocumentRequest (1.53.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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 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}.

Returns
Type Description
string

setName

Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Parameter
Name Description
var string
Returns
Type Description
$this

getCurrentDocument

An optional precondition on the document.

The request will fail if this is set and not met by the target document.

Returns
Type Description
Precondition|null

hasCurrentDocument

clearCurrentDocument

setCurrentDocument

An optional precondition on the document.

The request will fail if this is set and not met by the target document.

Parameter
Name Description
var Precondition
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.
Returns
Type Description
DeleteDocumentRequest