Class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1IndexField
- Inherits:
-
Object
- Object
- Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1IndexField
- 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
-
#field_path ⇒ String
The path of the field.
-
#mode ⇒ String
The field's mode.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleFirestoreAdminV1beta1IndexField
constructor
A new instance of GoogleFirestoreAdminV1beta1IndexField.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleFirestoreAdminV1beta1IndexField
Returns a new instance of GoogleFirestoreAdminV1beta1IndexField
979 980 981 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 979 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
972 973 974 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 972 def field_path @field_path end |
#mode ⇒ String
The field's mode.
Corresponds to the JSON property mode
977 978 979 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 977 def mode @mode end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
984 985 986 987 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 984 def update!(**args) @field_path = args[:field_path] if args.key?(:field_path) @mode = args[:mode] if args.key?(:mode) end |