Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::StructuredQuery::CollectionSelector (v2.2.1)

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

A selection of a collection, such as messages as m1.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#all_descendants

def all_descendants() -> ::Boolean
Returns
  • (::Boolean) — When false, selects only collections that are immediate children of the parent specified in the containing RunQueryRequest. When true, selects all descendant collections.

#all_descendants=

def all_descendants=(value) -> ::Boolean
Parameter
  • value (::Boolean) — When false, selects only collections that are immediate children of the parent specified in the containing RunQueryRequest. When true, selects all descendant collections.
Returns
  • (::Boolean) — When false, selects only collections that are immediate children of the parent specified in the containing RunQueryRequest. When true, selects all descendant collections.

#collection_id

def collection_id() -> ::String
Returns
  • (::String) — The collection ID. When set, selects only collections with this ID.

#collection_id=

def collection_id=(value) -> ::String
Parameter
  • value (::String) — The collection ID. When set, selects only collections with this ID.
Returns
  • (::String) — The collection ID. When set, selects only collections with this ID.