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

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::FieldReference

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

• #field_path ⇒ String

  A reference to a field in a document.

Instance Method Summary

• #initialize(**args) ⇒ FieldReference constructor

  A new instance of FieldReference.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ FieldReference

Returns a new instance of FieldReference.

# File 'lib/google/apis/firestore_v1/classes.rb', line 1004

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)

# File 'lib/google/apis/firestore_v1/classes.rb', line 1002

def field_path
  @field_path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/firestore_v1/classes.rb', line 1009

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