Class: Google::Apis::FirestoreV1::ListenResponse

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

Overview

The response for Firestore.Listen.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ListenResponse

Returns a new instance of ListenResponse.



1686
1687
1688
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1686

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

Instance Attribute Details

#document_change ⇒ Google::Apis::FirestoreV1::DocumentChange

A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected. Corresponds to the JSON property documentChange

Returns:



1655
1656
1657
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1655

def document_change
  @document_change
end

#document_delete ⇒ Google::Apis::FirestoreV1::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. Corresponds to the JSON property documentDelete

Returns:



1664
1665
1666
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1664

def document_delete
  @document_delete
end

#document_remove ⇒ Google::Apis::FirestoreV1::DocumentRemove

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. Corresponds to the JSON property documentRemove

Returns:



1674
1675
1676
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1674

def document_remove
  @document_remove
end

#filter ⇒ Google::Apis::FirestoreV1::ExistenceFilter

A digest of all the documents that match a given target. Corresponds to the JSON property filter

Returns:



1679
1680
1681
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1679

def filter
  @filter
end

#target_change ⇒ Google::Apis::FirestoreV1::TargetChange

Targets being watched have changed. Corresponds to the JSON property targetChange

Returns:



1684
1685
1686
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1684

def target_change
  @target_change
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1691
1692
1693
1694
1695
1696
1697
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1691

def update!(**args)
  @document_change = args[:document_change] if args.key?(:document_change)
  @document_delete = args[:document_delete] if args.key?(:document_delete)
  @document_remove = args[:document_remove] if args.key?(:document_remove)
  @filter = args[:filter] if args.key?(:filter)
  @target_change = args[:target_change] if args.key?(:target_change)
end