Class: Google::Firestore::V1::DeleteDocumentRequest

Inherits:

Object

• Object
• Google::Firestore::V1::DeleteDocumentRequest

Defined in:

lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb

Overview

The request for Firestore::DeleteDocument.

Instance Attribute Summary

• #current_document ⇒ Google::Firestore::V1::Precondition

  An optional precondition on the document.

• #name ⇒ String

  Required.

Instance Attribute Details

#current_document ⇒ Google::Firestore::V1::Precondition

Returns An optional precondition on the document. The request will fail if this is set and not met by the target document.

Returns:

• (Google::Firestore::V1::Precondition) —

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

# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 154

class DeleteDocumentRequest; end

#name ⇒ String

Returns 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}.

# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 154

class DeleteDocumentRequest; end