Class PropertyTransform (2.23.0)

public final class PropertyTransform extends GeneratedMessageV3 implements PropertyTransformOrBuilder

A transformation of an entity property.

Protobuf type google.datastore.v1.PropertyTransform

Static Fields

APPEND_MISSING_ELEMENTS_FIELD_NUMBER

public static final int APPEND_MISSING_ELEMENTS_FIELD_NUMBER
Field Value
Type Description
int

INCREMENT_FIELD_NUMBER

public static final int INCREMENT_FIELD_NUMBER
Field Value
Type Description
int

MAXIMUM_FIELD_NUMBER

public static final int MAXIMUM_FIELD_NUMBER
Field Value
Type Description
int

MINIMUM_FIELD_NUMBER

public static final int MINIMUM_FIELD_NUMBER
Field Value
Type Description
int

PROPERTY_FIELD_NUMBER

public static final int PROPERTY_FIELD_NUMBER
Field Value
Type Description
int

REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER

public static final int REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER
Field Value
Type Description
int

SET_TO_SERVER_VALUE_FIELD_NUMBER

public static final int SET_TO_SERVER_VALUE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PropertyTransform getDefaultInstance()
Returns
Type Description
PropertyTransform

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PropertyTransform.Builder newBuilder()
Returns
Type Description
PropertyTransform.Builder

newBuilder(PropertyTransform prototype)

public static PropertyTransform.Builder newBuilder(PropertyTransform prototype)
Parameter
Name Description
prototype PropertyTransform
Returns
Type Description
PropertyTransform.Builder

parseDelimitedFrom(InputStream input)

public static PropertyTransform parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PropertyTransform
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PropertyTransform parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PropertyTransform parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PropertyTransform
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PropertyTransform parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PropertyTransform parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PropertyTransform
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PropertyTransform parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PropertyTransform parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PropertyTransform
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PropertyTransform parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PropertyTransform parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PropertyTransform
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PropertyTransform parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PropertyTransform parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PropertyTransform
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PropertyTransform parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PropertyTransform> parser()
Returns
Type Description
Parser<PropertyTransform>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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;

Returns
Type Description
ArrayValue

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;

Returns
Type Description
ArrayValueOrBuilder

getDefaultInstanceForType()

public PropertyTransform getDefaultInstanceForType()
Returns
Type Description
PropertyTransform

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;

Returns
Type Description
Value

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;

Returns
Type Description
ValueOrBuilder

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;

Returns
Type Description
Value

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;

Returns
Type Description
ValueOrBuilder

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;

Returns
Type Description
Value

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;

Returns
Type Description
ValueOrBuilder

getParserForType()

public Parser<PropertyTransform> getParserForType()
Returns
Type Description
Parser<PropertyTransform>
Overrides

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];

Returns
Type Description
String

The property.

getPropertyBytes()

public 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
Type Description
ByteString

The bytes for property.

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;

Returns
Type Description
ArrayValue

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;

Returns
Type Description
ArrayValueOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSetToServerValue()

public PropertyTransform.ServerValue getSetToServerValue()

Sets the property to the given server value.

.google.datastore.v1.PropertyTransform.ServerValue set_to_server_value = 2;

Returns
Type Description
PropertyTransform.ServerValue

The setToServerValue.

getSetToServerValueValue()

public int getSetToServerValueValue()

Sets the property to the given server value.

.google.datastore.v1.PropertyTransform.ServerValue set_to_server_value = 2;

Returns
Type Description
int

The enum numeric value on the wire for setToServerValue.

getTransformTypeCase()

public PropertyTransform.TransformTypeCase getTransformTypeCase()
Returns
Type Description
PropertyTransform.TransformTypeCase

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;

Returns
Type Description
boolean

Whether the appendMissingElements field is set.

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;

Returns
Type Description
boolean

Whether the increment field is set.

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;

Returns
Type Description
boolean

Whether the maximum field is set.

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;

Returns
Type Description
boolean

Whether the minimum field is set.

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;

Returns
Type Description
boolean

Whether the removeAllFromArray field is set.

hasSetToServerValue()

public boolean hasSetToServerValue()

Sets the property to the given server value.

.google.datastore.v1.PropertyTransform.ServerValue set_to_server_value = 2;

Returns
Type Description
boolean

Whether the setToServerValue field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PropertyTransform.Builder newBuilderForType()
Returns
Type Description
PropertyTransform.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PropertyTransform.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PropertyTransform.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PropertyTransform.Builder toBuilder()
Returns
Type Description
PropertyTransform.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException