Class: Google::Apis::FirestoreV1beta1::IndexField

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

Overview

A field of an index.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ IndexField

Returns a new instance of IndexField



772
773
774
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 772

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

Instance Attribute Details

#field_path ⇒ String

The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path __name__ may be used by itself or at the end of a path. __type__ may be used only at the end of path. Corresponds to the JSON property fieldPath

Returns:

  • (String) 


765
766
767
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 765

def field_path
  @field_path
end

#mode ⇒ String

The field's mode. Corresponds to the JSON property mode

Returns:

  • (String) 


770
771
772
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 770

def mode
  @mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



777
778
779
780
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 777

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