Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::ListenResponse (v1.3.0)

Version latest

• 1.3.0 (latest)
• 1.2.0
• 1.1.1
• 1.0.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.8

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

The response for Firestore.Listen.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#document_change

def document_change() -> ::Google::Cloud::Firestore::V1::DocumentChange

Returns

• (::Google::Cloud::Firestore::V1::DocumentChange) — A Document has changed.

  Note: The following fields are mutually exclusive: document_change, target_change, document_delete, document_remove, filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

#document_change=

def document_change=(value) -> ::Google::Cloud::Firestore::V1::DocumentChange

Parameter

• value (::Google::Cloud::Firestore::V1::DocumentChange) — A Document has changed.

  Note: The following fields are mutually exclusive: document_change, target_change, document_delete, document_remove, filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Firestore::V1::DocumentChange) — A Document has changed.

  Note: The following fields are mutually exclusive: document_change, target_change, document_delete, document_remove, filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

#document_delete

def document_delete() -> ::Google::Cloud::Firestore::V1::DocumentDelete

Returns

• (::Google::Cloud::Firestore::V1::DocumentDelete) — A Document has been deleted.

  Note: The following fields are mutually exclusive: document_delete, target_change, document_change, document_remove, filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

#document_delete=

def document_delete=(value) -> ::Google::Cloud::Firestore::V1::DocumentDelete

Parameter

• value (::Google::Cloud::Firestore::V1::DocumentDelete) — A Document has been deleted.

  Note: The following fields are mutually exclusive: document_delete, target_change, document_change, document_remove, filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Firestore::V1::DocumentDelete) — A Document has been deleted.

  Note: The following fields are mutually exclusive: document_delete, target_change, document_change, document_remove, filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

#document_remove

def document_remove() -> ::Google::Cloud::Firestore::V1::DocumentRemove

Returns

• (::Google::Cloud::Firestore::V1::DocumentRemove) — A Document has been removed from a target (because it is no longer relevant to that target).

  Note: The following fields are mutually exclusive: document_remove, target_change, document_change, document_delete, filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

#document_remove=

def document_remove=(value) -> ::Google::Cloud::Firestore::V1::DocumentRemove

Parameter

• value (::Google::Cloud::Firestore::V1::DocumentRemove) — A Document has been removed from a target (because it is no longer relevant to that target).

  Note: The following fields are mutually exclusive: document_remove, target_change, document_change, document_delete, filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Firestore::V1::DocumentRemove) — A Document has been removed from a target (because it is no longer relevant to that target).

  Note: The following fields are mutually exclusive: document_remove, target_change, document_change, document_delete, filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

#filter

def filter() -> ::Google::Cloud::Firestore::V1::ExistenceFilter

Returns

• (::Google::Cloud::Firestore::V1::ExistenceFilter) — A filter to apply to the set of documents previously returned for the given target.

  Returned when documents may have been removed from the given target, but the exact documents are unknown.

  Note: The following fields are mutually exclusive: filter, target_change, document_change, document_delete, document_remove. If a field in that set is populated, all other fields in the set will automatically be cleared.

#filter=

def filter=(value) -> ::Google::Cloud::Firestore::V1::ExistenceFilter

Parameter

• value (::Google::Cloud::Firestore::V1::ExistenceFilter) — A filter to apply to the set of documents previously returned for the given target.

  Returned when documents may have been removed from the given target, but the exact documents are unknown.

  Note: The following fields are mutually exclusive: filter, target_change, document_change, document_delete, document_remove. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Firestore::V1::ExistenceFilter) — A filter to apply to the set of documents previously returned for the given target.

  Returned when documents may have been removed from the given target, but the exact documents are unknown.

  Note: The following fields are mutually exclusive: filter, target_change, document_change, document_delete, document_remove. If a field in that set is populated, all other fields in the set will automatically be cleared.

#target_change

def target_change() -> ::Google::Cloud::Firestore::V1::TargetChange

Returns

• (::Google::Cloud::Firestore::V1::TargetChange) — Targets have changed.

  Note: The following fields are mutually exclusive: target_change, document_change, document_delete, document_remove, filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

#target_change=

def target_change=(value) -> ::Google::Cloud::Firestore::V1::TargetChange

Parameter

• value (::Google::Cloud::Firestore::V1::TargetChange) — Targets have changed.

  Note: The following fields are mutually exclusive: target_change, document_change, document_delete, document_remove, filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Firestore::V1::TargetChange) — Targets have changed.

  Note: The following fields are mutually exclusive: target_change, document_change, document_delete, document_remove, filter. If a field in that set is populated, all other fields in the set will automatically be cleared.