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.



900
901
902
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 900

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

Instance Attribute Details

#field_path ⇒ String

A reference to a field in a document. Requires: * MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations. Corresponds to the JSON property fieldPath

Returns:

  • (String) 


898
899
900
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 898

def field_path
  @field_path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



905
906
907
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 905

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