Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::PropertyTransform (v1.1.0)

Version latest

• 1.1.0 (latest)
• 1.0.1
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.3
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.5

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::PropertyTransform.

A transformation of an entity property.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#append_missing_elements

def append_missing_elements() -> ::Google::Cloud::Datastore::V1::ArrayValue

Returns

• (::Google::Cloud::Datastore::V1::ArrayValue) — Appends the given elements in order if they are not already present in the current property value. If the property is not an array, or if the property 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 the null value is equal to the null value. If the input contains multiple equivalent values, only the first will be considered.

  The corresponding transform result will be the null value.

#append_missing_elements=

def append_missing_elements=(value) -> ::Google::Cloud::Datastore::V1::ArrayValue

Parameter

• value (::Google::Cloud::Datastore::V1::ArrayValue) — Appends the given elements in order if they are not already present in the current property value. If the property is not an array, or if the property 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 the null value is equal to the null value. If the input contains multiple equivalent values, only the first will be considered.

  The corresponding transform result will be the null value.

Returns

• (::Google::Cloud::Datastore::V1::ArrayValue) — Appends the given elements in order if they are not already present in the current property value. If the property is not an array, or if the property 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 the null value is equal to the null value. If the input contains multiple equivalent values, only the first will be considered.

  The corresponding transform result will be the null value.

#increment

def increment() -> ::Google::Cloud::Datastore::V1::Value

Returns

• (::Google::Cloud::Datastore::V1::Value) — Adds the given value to the property's current value.

  This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If either of the given value or the current property value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follows IEEE 754 semantics. If there is positive/negative integer overflow, the property is resolved to the largest magnitude positive/negative integer.

#increment=

def increment=(value) -> ::Google::Cloud::Datastore::V1::Value

Parameter

• value (::Google::Cloud::Datastore::V1::Value) — Adds the given value to the property's current value.

  This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If either of the given value or the current property value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follows IEEE 754 semantics. If there is positive/negative integer overflow, the property is resolved to the largest magnitude positive/negative integer.

Returns

• (::Google::Cloud::Datastore::V1::Value) — Adds the given value to the property's current value.

  This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If either of the given value or the current property value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follows IEEE 754 semantics. If there is positive/negative integer overflow, the property is resolved to the largest magnitude positive/negative integer.

#maximum

def maximum() -> ::Google::Cloud::Datastore::V1::Value

Returns

• (::Google::Cloud::Datastore::V1::Value) — Sets the property to the maximum of its current value and the given value.

  This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If a maximum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.

#maximum=

def maximum=(value) -> ::Google::Cloud::Datastore::V1::Value

Parameter

• value (::Google::Cloud::Datastore::V1::Value) — Sets the property to the maximum of its current value and the given value.

  This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If a maximum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.

Returns

• (::Google::Cloud::Datastore::V1::Value) — Sets the property to the maximum of its current value and the given value.

  This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If a maximum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.

#minimum

def minimum() -> ::Google::Cloud::Datastore::V1::Value

Returns

• (::Google::Cloud::Datastore::V1::Value) — Sets the property to the minimum of its current value and the given value.

  This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the input value. If a minimum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.

#minimum=

def minimum=(value) -> ::Google::Cloud::Datastore::V1::Value

Parameter

• value (::Google::Cloud::Datastore::V1::Value) — Sets the property to the minimum of its current value and the given value.

  This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the input value. If a minimum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.

Returns

• (::Google::Cloud::Datastore::V1::Value) — Sets the property to the minimum of its current value and the given value.

  This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the input value. If a minimum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.

#property

def property() -> ::String

Returns

• (::String) — Optional. The name of the property.

  Property paths (a list of property names separated by dots (.)) may be used to refer to properties inside entity values. For example foo.bar means the property bar inside the entity property foo.

  If a property name contains a dot . or a backlslash \, then that name must be escaped.

#property=

def property=(value) -> ::String

Parameter

• value (::String) — Optional. The name of the property.

  Property paths (a list of property names separated by dots (.)) may be used to refer to properties inside entity values. For example foo.bar means the property bar inside the entity property foo.

  If a property name contains a dot . or a backlslash \, then that name must be escaped.

Returns

• (::String) — Optional. The name of the property.

  Property paths (a list of property names separated by dots (.)) may be used to refer to properties inside entity values. For example foo.bar means the property bar inside the entity property foo.

  If a property name contains a dot . or a backlslash \, then that name must be escaped.

#remove_all_from_array

def remove_all_from_array() -> ::Google::Cloud::Datastore::V1::ArrayValue

Returns

• (::Google::Cloud::Datastore::V1::ArrayValue) — Removes all of the given elements from the array in the property. If the property is not an array, or if the property does not yet exist, it is set to the empty array.

  Equivalent numbers of 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 the null value is equal to the null value. This will remove all equivalent values if there are duplicates.

  The corresponding transform result will be the null value.

#remove_all_from_array=

def remove_all_from_array=(value) -> ::Google::Cloud::Datastore::V1::ArrayValue

Parameter

• value (::Google::Cloud::Datastore::V1::ArrayValue) — Removes all of the given elements from the array in the property. If the property is not an array, or if the property does not yet exist, it is set to the empty array.

  Equivalent numbers of 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 the null value is equal to the null value. This will remove all equivalent values if there are duplicates.

  The corresponding transform result will be the null value.

Returns

• (::Google::Cloud::Datastore::V1::ArrayValue) — Removes all of the given elements from the array in the property. If the property is not an array, or if the property does not yet exist, it is set to the empty array.

  Equivalent numbers of 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 the null value is equal to the null value. This will remove all equivalent values if there are duplicates.

  The corresponding transform result will be the null value.

#set_to_server_value

def set_to_server_value() -> ::Google::Cloud::Datastore::V1::PropertyTransform::ServerValue

Returns

• (::Google::Cloud::Datastore::V1::PropertyTransform::ServerValue) — Sets the property to the given server value.

#set_to_server_value=

def set_to_server_value=(value) -> ::Google::Cloud::Datastore::V1::PropertyTransform::ServerValue

Parameter

• value (::Google::Cloud::Datastore::V1::PropertyTransform::ServerValue) — Sets the property to the given server value.

Returns

• (::Google::Cloud::Datastore::V1::PropertyTransform::ServerValue) — Sets the property to the given server value.