Package com.google.datastore.v1

Class PropertyTransform

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.v1.PropertyTransform
All Implemented Interfaces:
PropertyTransformOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class PropertyTransform extends com.google.protobuf.GeneratedMessageV3 implements PropertyTransformOrBuilder
 A transformation of an entity property.
Protobuf type google.datastore.v1.PropertyTransform
See Also:

  • Field Details

    • PROPERTY_FIELD_NUMBER

      public static final int PROPERTY_FIELD_NUMBER
      See Also:

    • SET_TO_SERVER_VALUE_FIELD_NUMBER

      public static final int SET_TO_SERVER_VALUE_FIELD_NUMBER
      See Also:

    • INCREMENT_FIELD_NUMBER

      public static final int INCREMENT_FIELD_NUMBER
      See Also:

    • MAXIMUM_FIELD_NUMBER

      public static final int MAXIMUM_FIELD_NUMBER
      See Also:

    • MINIMUM_FIELD_NUMBER

      public static final int MINIMUM_FIELD_NUMBER
      See Also:

    • APPEND_MISSING_ELEMENTS_FIELD_NUMBER

      public static final int APPEND_MISSING_ELEMENTS_FIELD_NUMBER
      See Also:

    • REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER

      public static final int REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getTransformTypeCase

      public PropertyTransform.TransformTypeCase getTransformTypeCase()
      Specified by:
      getTransformTypeCase in interface PropertyTransformOrBuilder

    • getProperty

      public 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];
      Specified by:
      getProperty in interface PropertyTransformOrBuilder
      Returns:
      The property.

    • getPropertyBytes

      public 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];
      Specified by:
      getPropertyBytes in interface PropertyTransformOrBuilder
      Returns:
      The bytes for property.

    • hasSetToServerValue

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

    • getSetToServerValueValue

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

    • getSetToServerValue

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

    • hasIncrement

      public 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;
      Specified by:
      hasIncrement in interface PropertyTransformOrBuilder
      Returns:
      Whether the increment field is set.

    • getIncrement

      public 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;
      Specified by:
      getIncrement in interface PropertyTransformOrBuilder
      Returns:
      The increment.

    • getIncrementOrBuilder

      public 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;
      Specified by:
      getIncrementOrBuilder in interface PropertyTransformOrBuilder

    • hasMaximum

      public 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;
      Specified by:
      hasMaximum in interface PropertyTransformOrBuilder
      Returns:
      Whether the maximum field is set.

    • getMaximum

      public 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;
      Specified by:
      getMaximum in interface PropertyTransformOrBuilder
      Returns:
      The maximum.

    • getMaximumOrBuilder

      public 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;
      Specified by:
      getMaximumOrBuilder in interface PropertyTransformOrBuilder

    • hasMinimum

      public 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;
      Specified by:
      hasMinimum in interface PropertyTransformOrBuilder
      Returns:
      Whether the minimum field is set.

    • getMinimum

      public 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;
      Specified by:
      getMinimum in interface PropertyTransformOrBuilder
      Returns:
      The minimum.

    • getMinimumOrBuilder

      public 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;
      Specified by:
      getMinimumOrBuilder in interface PropertyTransformOrBuilder

    • hasAppendMissingElements

      public 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;
      Specified by:
      hasAppendMissingElements in interface PropertyTransformOrBuilder
      Returns:
      Whether the appendMissingElements field is set.

    • getAppendMissingElements

      public 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;
      Specified by:
      getAppendMissingElements in interface PropertyTransformOrBuilder
      Returns:
      The appendMissingElements.

    • getAppendMissingElementsOrBuilder

      public 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;
      Specified by:
      getAppendMissingElementsOrBuilder in interface PropertyTransformOrBuilder

    • hasRemoveAllFromArray

      public 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;
      Specified by:
      hasRemoveAllFromArray in interface PropertyTransformOrBuilder
      Returns:
      Whether the removeAllFromArray field is set.

    • getRemoveAllFromArray

      public 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;
      Specified by:
      getRemoveAllFromArray in interface PropertyTransformOrBuilder
      Returns:
      The removeAllFromArray.

    • getRemoveAllFromArrayOrBuilder

      public 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;
      Specified by:
      getRemoveAllFromArrayOrBuilder in interface PropertyTransformOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PropertyTransform parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PropertyTransform parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PropertyTransform parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PropertyTransform parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PropertyTransform parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PropertyTransform parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PropertyTransform parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PropertyTransform parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PropertyTransform parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PropertyTransform parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PropertyTransform parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PropertyTransform parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PropertyTransform.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PropertyTransform.Builder newBuilder()

    • newBuilder

      public static PropertyTransform.Builder newBuilder(PropertyTransform prototype)

    • toBuilder

      public PropertyTransform.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PropertyTransform.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static PropertyTransform getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PropertyTransform> parser()

    • getParserForType

      public com.google.protobuf.Parser<PropertyTransform> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public PropertyTransform getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder