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.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/write.rb', line 60

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.
  # @!attribute [rw] append_missing_elements
  #   @return [Google::Firestore::V1beta1::ArrayValue]
  #     Append the given elements in order if they are not already present in
  #     the current field value.
  #     If the field is not an array, or if the field does not yet exist, it is
  #     first set to the empty array.
  #
  #     Equivalent numbers of different types (e.g. 3L and 3.0) are
  #     considered equal when checking if a value is missing.
  #     NaN is equal to NaN, and Null is equal to Null.
  #     If the input contains multiple equivalent values, only the first will
  #     be considered.
  #
  #     The corresponding transform_result will be the null value.
  # @!attribute [rw] remove_all_from_array
  #   @return [Google::Firestore::V1beta1::ArrayValue]
  #     Remove all of the given elements from the array in the field.
  #     If the field is not an array, or if the field does not yet exist, it is
  #     set to the empty array.
  #
  #     Equivalent numbers of the different types (e.g. 3L and 3.0) are
  #     considered equal when deciding whether an element should be removed.
  #     NaN is equal to NaN, and Null is equal to Null.
  #     This will remove all equivalent values if there are duplicates.
  #
  #     The corresponding transform_result will be the null 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, with millisecond
      # precision.
      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. This must not be empty.

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/write.rb', line 60

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.
  # @!attribute [rw] append_missing_elements
  #   @return [Google::Firestore::V1beta1::ArrayValue]
  #     Append the given elements in order if they are not already present in
  #     the current field value.
  #     If the field is not an array, or if the field does not yet exist, it is
  #     first set to the empty array.
  #
  #     Equivalent numbers of different types (e.g. 3L and 3.0) are
  #     considered equal when checking if a value is missing.
  #     NaN is equal to NaN, and Null is equal to Null.
  #     If the input contains multiple equivalent values, only the first will
  #     be considered.
  #
  #     The corresponding transform_result will be the null value.
  # @!attribute [rw] remove_all_from_array
  #   @return [Google::Firestore::V1beta1::ArrayValue]
  #     Remove all of the given elements from the array in the field.
  #     If the field is not an array, or if the field does not yet exist, it is
  #     set to the empty array.
  #
  #     Equivalent numbers of the different types (e.g. 3L and 3.0) are
  #     considered equal when deciding whether an element should be removed.
  #     NaN is equal to NaN, and Null is equal to Null.
  #     This will remove all equivalent values if there are duplicates.
  #
  #     The corresponding transform_result will be the null 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, with millisecond
      # precision.
      REQUEST_TIME = 1
    end
  end
end