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

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::Projection

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/firestore_v1/classes.rb,
generated/google/apis/firestore_v1/representations.rb,
generated/google/apis/firestore_v1/representations.rb

Overview

The projection of document's fields to return.

Instance Attribute Summary

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

  The fields to return.

Instance Method Summary

• #initialize(**args) ⇒ Projection constructor

  A new instance of Projection.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ Projection

Returns a new instance of Projection.

# File 'generated/google/apis/firestore_v1/classes.rb', line 1919

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:

• (Array<Google::Apis::FirestoreV1::FieldReference>)

# File 'generated/google/apis/firestore_v1/classes.rb', line 1917

def fields
  @fields
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/firestore_v1/classes.rb', line 1924

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