Class: Google::Apis::FirestoreV1beta1::FieldTransform

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 transformation of a field of the document.

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) ⇒ FieldTransform

Returns a new instance of FieldTransform



674
675
676
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 674

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

Instance Attribute Details

#field_path ⇒ String

The path of the field. See Document.fields for the field path syntax reference. Corresponds to the JSON property fieldPath

Returns:

  • (String) 


667
668
669
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 667

def field_path
  @field_path
end

#set_to_server_value ⇒ String

Sets the field to the given server value. Corresponds to the JSON property setToServerValue

Returns:

  • (String) 


672
673
674
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 672

def set_to_server_value
  @set_to_server_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



679
680
681
682
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 679

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