Class: Google::Apis::FirestoreV1::FieldTransform

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

Overview

A transformation of a field of the document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FieldTransform

Returns a new instance of FieldTransform.



731
732
733
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 731

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

Instance Attribute Details

#append_missing_elements ⇒ Google::Apis::FirestoreV1::ArrayValue

An array value. Corresponds to the JSON property appendMissingElements

Returns:



699
700
701
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 699

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

Returns:

  • (String) 


704
705
706
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 704

def field_path
  @field_path
end

#increment ⇒ Google::Apis::FirestoreV1::Value

A message that can hold any of the supported value types. Corresponds to the JSON property increment

Returns:



709
710
711
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 709

def increment
  @increment
end

#maximum ⇒ Google::Apis::FirestoreV1::Value

A message that can hold any of the supported value types. Corresponds to the JSON property maximum

Returns:



714
715
716
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 714

def maximum
  @maximum
end

#minimum ⇒ Google::Apis::FirestoreV1::Value

A message that can hold any of the supported value types. Corresponds to the JSON property minimum

Returns:



719
720
721
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 719

def minimum
  @minimum
end

#remove_all_from_array ⇒ Google::Apis::FirestoreV1::ArrayValue

An array value. Corresponds to the JSON property removeAllFromArray

Returns:



724
725
726
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 724

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

Returns:

  • (String) 


729
730
731
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 729

def set_to_server_value
  @set_to_server_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



736
737
738
739
740
741
742
743
744
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 736

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