Class: Google::Apis::FirestoreV1beta1::DocumentTransform

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

Returns a new instance of DocumentTransform.


565
566
567
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 565

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

Instance Attribute Details

#documentString

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

Returns:

  • (String)

557
558
559
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 557

def document
  @document
end

#field_transformsArray<Google::Apis::FirestoreV1beta1::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


563
564
565
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 563

def field_transforms
  @field_transforms
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


570
571
572
573
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 570

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