Class: Google::Firestore::V1beta1::DocumentTransform

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/write.rb

Overview

A transformation of a document.

Defined Under Namespace

Classes: FieldTransform

Instance Attribute Summary collapse

Instance Attribute Details

#document ⇒ String

Returns The name of the document to transform.

Returns:

  • (String) —

    The name of the document to transform.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/write.rb', line 58

class DocumentTransform
  # A transformation of a field of the document.
  # @!attribute [rw] field_path
  #   @return [String]
  #     The path of the field. See {Google::Firestore::V1beta1::Document#fields Document#fields} for the field path syntax
  #     reference.
  # @!attribute [rw] set_to_server_value
  #   @return [Google::Firestore::V1beta1::DocumentTransform::FieldTransform::ServerValue]
  #     Sets the field to the given server value.
  class FieldTransform
    # A value that is calculated by the server.
    module ServerValue
      # Unspecified. This value must not be used.
      SERVER_VALUE_UNSPECIFIED = 0

      # The time at which the server processed the request.
      REQUEST_TIME = 1
    end
  end
end

#field_transforms ⇒ Array<Google::Firestore::V1beta1::DocumentTransform::FieldTransform>

Returns The list of transformations to apply to the fields of the document, in order.

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/write.rb', line 58

class DocumentTransform
  # A transformation of a field of the document.
  # @!attribute [rw] field_path
  #   @return [String]
  #     The path of the field. See {Google::Firestore::V1beta1::Document#fields Document#fields} for the field path syntax
  #     reference.
  # @!attribute [rw] set_to_server_value
  #   @return [Google::Firestore::V1beta1::DocumentTransform::FieldTransform::ServerValue]
  #     Sets the field to the given server value.
  class FieldTransform
    # A value that is calculated by the server.
    module ServerValue
      # Unspecified. This value must not be used.
      SERVER_VALUE_UNSPECIFIED = 0

      # The time at which the server processed the request.
      REQUEST_TIME = 1
    end
  end
end