Class: Google::Apis::FirestoreV1beta1::CollectionSelector

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

Overview

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

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) ⇒ CollectionSelector

Returns a new instance of CollectionSelector.


248
249
250
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 248

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

Instance Attribute Details

#all_descendantsBoolean Also known as: all_descendants?

When false, selects only collections that are immediate children of the parent specified in the containing RunQueryRequest. When true, selects all descendant collections. Corresponds to the JSON property allDescendants

Returns:

  • (Boolean)

240
241
242
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 240

def all_descendants
  @all_descendants
end

#collection_idString

The collection ID. When set, selects only collections with this ID. Corresponds to the JSON property collectionId

Returns:

  • (String)

246
247
248
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 246

def collection_id
  @collection_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


253
254
255
256
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 253

def update!(**args)
  @all_descendants = args[:all_descendants] if args.key?(:all_descendants)
  @collection_id = args[:collection_id] if args.key?(:collection_id)
end