Class: Google::Apis::FirestoreV1::FieldReference

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

A reference to a field in a document, ex: stats.operations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FieldReference

Returns a new instance of FieldReference.



858
859
860
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 858

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

Instance Attribute Details

#field_path ⇒ String

The relative path of the document being referenced. Requires: * Conform to document field name limitations. Corresponds to the JSON property fieldPath

Returns:

  • (String) 


856
857
858
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 856

def field_path
  @field_path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



863
864
865
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 863

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