Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::DeleteDocumentRequest.
The request for Firestore.DeleteDocument.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#current_document
def current_document() -> ::Google::Cloud::Firestore::V1::Precondition
Returns
- (::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.
#current_document=
def current_document=(value) -> ::Google::Cloud::Firestore::V1::Precondition
Parameter
- value (::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.
Returns
- (::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.
#name
def name() -> ::String
Returns
-
(::String) — Required. The resource name of the Document to delete. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Required. The resource name of the Document to delete. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
Returns
-
(::String) — Required. The resource name of the Document to delete. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.