Class: Google::Apis::FirestoreV1::Projection

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

Overview

The projection of document's fields to return.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Projection

Returns a new instance of Projection.



3308
3309
3310
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3308

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

Instance Attribute Details

#fields ⇒ Array<Google::Apis::FirestoreV1::FieldReference>

The fields to return. If empty, all fields are returned. To only return the name of the document, use ['__name__']. Corresponds to the JSON property fields

Returns:



3306
3307
3308
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3306

def fields
  @fields
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3313
3314
3315
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3313

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