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

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

A request for Firestore.Listen

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#add_target

def add_target() -> ::Google::Cloud::Firestore::V1::Target
Returns
  • (::Google::Cloud::Firestore::V1::Target) — A target to add to this stream.

    Note: The following fields are mutually exclusive: add_target, remove_target. If a field in that set is populated, all other fields in the set will automatically be cleared.

#add_target=

def add_target=(value) -> ::Google::Cloud::Firestore::V1::Target
Parameter
  • value (::Google::Cloud::Firestore::V1::Target) — A target to add to this stream.

    Note: The following fields are mutually exclusive: add_target, remove_target. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Firestore::V1::Target) — A target to add to this stream.

    Note: The following fields are mutually exclusive: add_target, remove_target. If a field in that set is populated, all other fields in the set will automatically be cleared.

#database

def database() -> ::String
Returns
  • (::String) — Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

#database=

def database=(value) -> ::String
Parameter
  • value (::String) — Required. The database name. In the format: projects/{project_id}/databases/{database_id}.
Returns
  • (::String) — Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this target change.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this target change.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this target change.

#remove_target

def remove_target() -> ::Integer
Returns
  • (::Integer) — The ID of a target to remove from this stream.

    Note: The following fields are mutually exclusive: remove_target, add_target. If a field in that set is populated, all other fields in the set will automatically be cleared.

#remove_target=

def remove_target=(value) -> ::Integer
Parameter
  • value (::Integer) — The ID of a target to remove from this stream.

    Note: The following fields are mutually exclusive: remove_target, add_target. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Integer) — The ID of a target to remove from this stream.

    Note: The following fields are mutually exclusive: remove_target, add_target. If a field in that set is populated, all other fields in the set will automatically be cleared.