Class: Google::Apis::FirestoreV1::DocumentDelete

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DocumentDelete

Returns a new instance of DocumentDelete.



693
694
695
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 693

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#document ⇒ String

The resource name of the Document that was deleted. Corresponds to the JSON property document

Returns:

  • (String) 


680
681
682
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 680

def document
  @document
end

#read_time ⇒ String

The read timestamp at which the delete was observed. Greater or equal to the commit_time of the delete. Corresponds to the JSON property readTime

Returns:

  • (String) 


686
687
688
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 686

def read_time
  @read_time
end

#removed_target_ids ⇒ Array<Fixnum>

A set of target IDs for targets that previously matched this entity. Corresponds to the JSON property removedTargetIds

Returns:

  • (Array<Fixnum>) 


691
692
693
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 691

def removed_target_ids
  @removed_target_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



698
699
700
701
702
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 698

def update!(**args)
  @document = args[:document] if args.key?(:document)
  @read_time = args[:read_time] if args.key?(:read_time)
  @removed_target_ids = args[:removed_target_ids] if args.key?(:removed_target_ids)
end