Class: Google::Apis::FirestoreV1::DocumentTransform

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

Overview

A transformation of a document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DocumentTransform

Returns a new instance of DocumentTransform.



780
781
782
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 780

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

Instance Attribute Details

#document ⇒ String

The name of the document to transform. Corresponds to the JSON property document

Returns:

  • (String) 


772
773
774
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 772

def document
  @document
end

#field_transforms ⇒ Array<Google::Apis::FirestoreV1::FieldTransform>

The list of transformations to apply to the fields of the document, in order. This must not be empty. Corresponds to the JSON property fieldTransforms

Returns:



778
779
780
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 778

def field_transforms
  @field_transforms
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



785
786
787
788
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 785

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