Class PropertyTransform.Builder (2.25.1)

public static final class PropertyTransform.Builder extends GeneratedMessageV3.Builder<PropertyTransform.Builder> implements PropertyTransformOrBuilder

A transformation of an entity property.

Protobuf type google.datastore.v1.PropertyTransform

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PropertyTransform.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PropertyTransform.Builder
Overrides

build()

public PropertyTransform build()
Returns
Type Description
PropertyTransform

buildPartial()

public PropertyTransform buildPartial()
Returns
Type Description
PropertyTransform

clear()

public PropertyTransform.Builder clear()
Returns
Type Description
PropertyTransform.Builder
Overrides

clearAppendMissingElements()

public PropertyTransform.Builder clearAppendMissingElements()

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
PropertyTransform.Builder

clearField(Descriptors.FieldDescriptor field)

public PropertyTransform.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PropertyTransform.Builder
Overrides

clearIncrement()

public PropertyTransform.Builder clearIncrement()

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
PropertyTransform.Builder

clearMaximum()

public PropertyTransform.Builder clearMaximum()

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
PropertyTransform.Builder

clearMinimum()

public PropertyTransform.Builder clearMinimum()

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
PropertyTransform.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public PropertyTransform.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PropertyTransform.Builder
Overrides

clearProperty()

public PropertyTransform.Builder clearProperty()

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
PropertyTransform.Builder

This builder for chaining.

clearRemoveAllFromArray()

public PropertyTransform.Builder clearRemoveAllFromArray()

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
PropertyTransform.Builder

clearSetToServerValue()

public PropertyTransform.Builder clearSetToServerValue()

Sets the property to the given server value.

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

Returns
Type Description
PropertyTransform.Builder

This builder for chaining.

clearTransformType()

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

clone()

public PropertyTransform.Builder clone()
Returns
Type Description
PropertyTransform.Builder
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.

getAppendMissingElementsBuilder()

public ArrayValue.Builder getAppendMissingElementsBuilder()

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.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getIncrementBuilder()

public Value.Builder getIncrementBuilder()

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.Builder

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.

getMaximumBuilder()

public Value.Builder getMaximumBuilder()

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.Builder

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.

getMinimumBuilder()

public Value.Builder getMinimumBuilder()

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.Builder

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

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.

getRemoveAllFromArrayBuilder()

public ArrayValue.Builder getRemoveAllFromArrayBuilder()

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.Builder

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAppendMissingElements(ArrayValue value)

public PropertyTransform.Builder mergeAppendMissingElements(ArrayValue value)

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;

Parameter
Name Description
value ArrayValue
Returns
Type Description
PropertyTransform.Builder

mergeFrom(PropertyTransform other)

public PropertyTransform.Builder mergeFrom(PropertyTransform other)
Parameter
Name Description
other PropertyTransform
Returns
Type Description
PropertyTransform.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PropertyTransform.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PropertyTransform.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PropertyTransform.Builder
Overrides

mergeIncrement(Value value)

public PropertyTransform.Builder mergeIncrement(Value 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.

.google.datastore.v1.Value increment = 3;

Parameter
Name Description
value Value
Returns
Type Description
PropertyTransform.Builder

mergeMaximum(Value value)

public PropertyTransform.Builder mergeMaximum(Value 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.

.google.datastore.v1.Value maximum = 4;

Parameter
Name Description
value Value
Returns
Type Description
PropertyTransform.Builder

mergeMinimum(Value value)

public PropertyTransform.Builder mergeMinimum(Value 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.

.google.datastore.v1.Value minimum = 5;

Parameter
Name Description
value Value
Returns
Type Description
PropertyTransform.Builder

mergeRemoveAllFromArray(ArrayValue value)

public PropertyTransform.Builder mergeRemoveAllFromArray(ArrayValue value)

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;

Parameter
Name Description
value ArrayValue
Returns
Type Description
PropertyTransform.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PropertyTransform.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PropertyTransform.Builder
Overrides

setAppendMissingElements(ArrayValue value)

public PropertyTransform.Builder setAppendMissingElements(ArrayValue value)

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;

Parameter
Name Description
value ArrayValue
Returns
Type Description
PropertyTransform.Builder

setAppendMissingElements(ArrayValue.Builder builderForValue)

public PropertyTransform.Builder setAppendMissingElements(ArrayValue.Builder builderForValue)

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;

Parameter
Name Description
builderForValue ArrayValue.Builder
Returns
Type Description
PropertyTransform.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PropertyTransform.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PropertyTransform.Builder
Overrides

setIncrement(Value value)

public PropertyTransform.Builder setIncrement(Value 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.

.google.datastore.v1.Value increment = 3;

Parameter
Name Description
value Value
Returns
Type Description
PropertyTransform.Builder

setIncrement(Value.Builder builderForValue)

public PropertyTransform.Builder setIncrement(Value.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Value.Builder
Returns
Type Description
PropertyTransform.Builder

setMaximum(Value value)

public PropertyTransform.Builder setMaximum(Value 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.

.google.datastore.v1.Value maximum = 4;

Parameter
Name Description
value Value
Returns
Type Description
PropertyTransform.Builder

setMaximum(Value.Builder builderForValue)

public PropertyTransform.Builder setMaximum(Value.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Value.Builder
Returns
Type Description
PropertyTransform.Builder

setMinimum(Value value)

public PropertyTransform.Builder setMinimum(Value 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.

.google.datastore.v1.Value minimum = 5;

Parameter
Name Description
value Value
Returns
Type Description
PropertyTransform.Builder

setMinimum(Value.Builder builderForValue)

public PropertyTransform.Builder setMinimum(Value.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Value.Builder
Returns
Type Description
PropertyTransform.Builder

setProperty(String value)

public PropertyTransform.Builder setProperty(String value)

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

Parameter
Name Description
value String

The property to set.

Returns
Type Description
PropertyTransform.Builder

This builder for chaining.

setPropertyBytes(ByteString value)

public PropertyTransform.Builder setPropertyBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for property to set.

Returns
Type Description
PropertyTransform.Builder

This builder for chaining.

setRemoveAllFromArray(ArrayValue value)

public PropertyTransform.Builder setRemoveAllFromArray(ArrayValue value)

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;

Parameter
Name Description
value ArrayValue
Returns
Type Description
PropertyTransform.Builder

setRemoveAllFromArray(ArrayValue.Builder builderForValue)

public PropertyTransform.Builder setRemoveAllFromArray(ArrayValue.Builder builderForValue)

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;

Parameter
Name Description
builderForValue ArrayValue.Builder
Returns
Type Description
PropertyTransform.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PropertyTransform.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PropertyTransform.Builder
Overrides

setSetToServerValue(PropertyTransform.ServerValue value)

public PropertyTransform.Builder setSetToServerValue(PropertyTransform.ServerValue value)

Sets the property to the given server value.

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

Parameter
Name Description
value PropertyTransform.ServerValue

The setToServerValue to set.

Returns
Type Description
PropertyTransform.Builder

This builder for chaining.

setSetToServerValueValue(int value)

public PropertyTransform.Builder setSetToServerValueValue(int value)

Sets the property to the given server value.

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

Parameter
Name Description
value int

The enum numeric value on the wire for setToServerValue to set.

Returns
Type Description
PropertyTransform.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PropertyTransform.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PropertyTransform.Builder
Overrides