Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::DocumentDelete (v0.14.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::DocumentDelete.

A Document has been deleted.

May be the result of multiple writes, including updates, the last of which deleted the Document.

Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#document

def document() -> ::String
Returns
  • (::String) — The resource name of the Document that was deleted.

#document=

def document=(value) -> ::String
Parameter
  • value (::String) — The resource name of the Document that was deleted.
Returns
  • (::String) — The resource name of the Document that was deleted.

#read_time

def read_time() -> ::Google::Protobuf::Timestamp
Returns

#read_time=

def read_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — The read timestamp at which the delete was observed.

    Greater or equal to the commit_time of the delete.

Returns

#removed_target_ids

def removed_target_ids() -> ::Array<::Integer>
Returns
  • (::Array<::Integer>) — A set of target IDs for targets that previously matched this entity.

#removed_target_ids=

def removed_target_ids=(value) -> ::Array<::Integer>
Parameter
  • value (::Array<::Integer>) — A set of target IDs for targets that previously matched this entity.
Returns
  • (::Array<::Integer>) — A set of target IDs for targets that previously matched this entity.