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

Inherits:

Object

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

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/firestore/v1/firestore.rb

Overview

The request for Firestore.DeleteDocument.

Instance Attribute Summary

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

  An optional precondition on the document.

• #name ⇒ ::String

  Required.

Instance Attribute Details

#current_document ⇒ ::Google::Cloud::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::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.

# File 'proto_docs/google/firestore/v1/firestore.rb', line 174

class DeleteDocumentRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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 'proto_docs/google/firestore/v1/firestore.rb', line 174

class DeleteDocumentRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end