Class: Google::Apis::FirestoreV1beta1::FieldTransform
- Inherits:
-
Object
- Object
- Google::Apis::FirestoreV1beta1::FieldTransform
- 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 transformation of a field of the document.
Instance Attribute Summary collapse
-
#append_missing_elements ⇒ Google::Apis::FirestoreV1beta1::ArrayValue
An array value.
-
#field_path ⇒ String
The path of the field.
-
#increment ⇒ Google::Apis::FirestoreV1beta1::Value
A message that can hold any of the supported value types.
-
#maximum ⇒ Google::Apis::FirestoreV1beta1::Value
A message that can hold any of the supported value types.
-
#minimum ⇒ Google::Apis::FirestoreV1beta1::Value
A message that can hold any of the supported value types.
-
#remove_all_from_array ⇒ Google::Apis::FirestoreV1beta1::ArrayValue
An array value.
-
#set_to_server_value ⇒ String
Sets the field to the given server value.
Instance Method Summary collapse
-
#initialize(**args) ⇒ FieldTransform
constructor
A new instance of FieldTransform.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ FieldTransform
Returns a new instance of FieldTransform.
700 701 702 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 700 def initialize(**args) update!(**args) end |
Instance Attribute Details
#append_missing_elements ⇒ Google::Apis::FirestoreV1beta1::ArrayValue
An array value.
Corresponds to the JSON property appendMissingElements
667 668 669 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 667 def append_missing_elements @append_missing_elements end |
#field_path ⇒ String
The path of the field. See Document.fields for the field path syntax
reference.
Corresponds to the JSON property fieldPath
673 674 675 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 673 def field_path @field_path end |
#increment ⇒ Google::Apis::FirestoreV1beta1::Value
A message that can hold any of the supported value types.
Corresponds to the JSON property increment
678 679 680 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 678 def increment @increment end |
#maximum ⇒ Google::Apis::FirestoreV1beta1::Value
A message that can hold any of the supported value types.
Corresponds to the JSON property maximum
683 684 685 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 683 def maximum @maximum end |
#minimum ⇒ Google::Apis::FirestoreV1beta1::Value
A message that can hold any of the supported value types.
Corresponds to the JSON property minimum
688 689 690 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 688 def minimum @minimum end |
#remove_all_from_array ⇒ Google::Apis::FirestoreV1beta1::ArrayValue
An array value.
Corresponds to the JSON property removeAllFromArray
693 694 695 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 693 def remove_all_from_array @remove_all_from_array end |
#set_to_server_value ⇒ String
Sets the field to the given server value.
Corresponds to the JSON property setToServerValue
698 699 700 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 698 def set_to_server_value @set_to_server_value end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
705 706 707 708 709 710 711 712 713 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 705 def update!(**args) @append_missing_elements = args[:append_missing_elements] if args.key?(:append_missing_elements) @field_path = args[:field_path] if args.key?(:field_path) @increment = args[:increment] if args.key?(:increment) @maximum = args[:maximum] if args.key?(:maximum) @minimum = args[:minimum] if args.key?(:minimum) @remove_all_from_array = args[:remove_all_from_array] if args.key?(:remove_all_from_array) @set_to_server_value = args[:set_to_server_value] if args.key?(:set_to_server_value) end |