Package com.google.datastore.v1

Interface PropertyTransformOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PropertyTransform, PropertyTransform.Builder
public interface PropertyTransformOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getProperty

      String getProperty()
       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.
      string property = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The property.

    • getPropertyBytes

      com.google.protobuf.ByteString getPropertyBytes()
       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.
      string property = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for property.

    • hasSetToServerValue

      boolean hasSetToServerValue()
       Sets the property to the given server value.
      .google.datastore.v1.PropertyTransform.ServerValue set_to_server_value = 2;
      Returns:
      Whether the setToServerValue field is set.

    • getSetToServerValueValue

      int getSetToServerValueValue()
       Sets the property to the given server value.
      .google.datastore.v1.PropertyTransform.ServerValue set_to_server_value = 2;
      Returns:
      The enum numeric value on the wire for setToServerValue.

    • getSetToServerValue

      PropertyTransform.ServerValue getSetToServerValue()
       Sets the property to the given server value.
      .google.datastore.v1.PropertyTransform.ServerValue set_to_server_value = 2;
      Returns:
      The setToServerValue.

    • hasIncrement

      boolean hasIncrement()
       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.
      .google.datastore.v1.Value increment = 3;
      Returns:
      Whether the increment field is set.

    • getIncrement

      Value getIncrement()
       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.
      .google.datastore.v1.Value increment = 3;
      Returns:
      The increment.

    • getIncrementOrBuilder

      ValueOrBuilder getIncrementOrBuilder()
       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.
      .google.datastore.v1.Value increment = 3;

    • hasMaximum

      boolean hasMaximum()
       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.
      .google.datastore.v1.Value maximum = 4;
      Returns:
      Whether the maximum field is set.

    • getMaximum

      Value getMaximum()
       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.
      .google.datastore.v1.Value maximum = 4;
      Returns:
      The maximum.

    • getMaximumOrBuilder

      ValueOrBuilder getMaximumOrBuilder()
       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.
      .google.datastore.v1.Value maximum = 4;

    • hasMinimum

      boolean hasMinimum()
       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.
      .google.datastore.v1.Value minimum = 5;
      Returns:
      Whether the minimum field is set.

    • getMinimum

      Value getMinimum()
       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.
      .google.datastore.v1.Value minimum = 5;
      Returns:
      The minimum.

    • getMinimumOrBuilder

      ValueOrBuilder getMinimumOrBuilder()
       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.
      .google.datastore.v1.Value minimum = 5;

    • hasAppendMissingElements

      boolean hasAppendMissingElements()
       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.
      .google.datastore.v1.ArrayValue append_missing_elements = 6;
      Returns:
      Whether the appendMissingElements field is set.

    • getAppendMissingElements

      ArrayValue getAppendMissingElements()
       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.
      .google.datastore.v1.ArrayValue append_missing_elements = 6;
      Returns:
      The appendMissingElements.

    • getAppendMissingElementsOrBuilder

      ArrayValueOrBuilder getAppendMissingElementsOrBuilder()
       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.
      .google.datastore.v1.ArrayValue append_missing_elements = 6;

    • hasRemoveAllFromArray

      boolean hasRemoveAllFromArray()
       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.
      .google.datastore.v1.ArrayValue remove_all_from_array = 7;
      Returns:
      Whether the removeAllFromArray field is set.

    • getRemoveAllFromArray

      ArrayValue getRemoveAllFromArray()
       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.
      .google.datastore.v1.ArrayValue remove_all_from_array = 7;
      Returns:
      The removeAllFromArray.

    • getRemoveAllFromArrayOrBuilder

      ArrayValueOrBuilder getRemoveAllFromArrayOrBuilder()
       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.
      .google.datastore.v1.ArrayValue remove_all_from_array = 7;

    • getTransformTypeCase

      PropertyTransform.TransformTypeCase getTransformTypeCase()