Class: Google::Apis::FirestoreV1::DocumentRemove

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 removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DocumentRemove

Returns a new instance of DocumentRemove.



739
740
741
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 739

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

Instance Attribute Details

#document ⇒ String

The resource name of the Document that has gone out of view. Corresponds to the JSON property document

Returns:

  • (String) 


726
727
728
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 726

def document
  @document
end

#read_time ⇒ String

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

Returns:

  • (String) 


732
733
734
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 732

def read_time
  @read_time
end

#removed_target_ids ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


737
738
739
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 737

def removed_target_ids
  @removed_target_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



744
745
746
747
748
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 744

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