Class PropertyTransform (2.28.2)

publicfinalclass PropertyTransformextendsGeneratedMessageV3implementsPropertyTransformOrBuilder

A transformation of an entity property.

Protobuf type google.datastore.v1.PropertyTransform

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

APPEND_MISSING_ELEMENTS_FIELD_NUMBER

publicstaticfinalintAPPEND_MISSING_ELEMENTS_FIELD_NUMBER
Field Value
Type Description
int

INCREMENT_FIELD_NUMBER

publicstaticfinalintINCREMENT_FIELD_NUMBER
Field Value
Type Description
int

MAXIMUM_FIELD_NUMBER

publicstaticfinalintMAXIMUM_FIELD_NUMBER
Field Value
Type Description
int

MINIMUM_FIELD_NUMBER

publicstaticfinalintMINIMUM_FIELD_NUMBER
Field Value
Type Description
int

PROPERTY_FIELD_NUMBER

publicstaticfinalintPROPERTY_FIELD_NUMBER
Field Value
Type Description
int

REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER

publicstaticfinalintREMOVE_ALL_FROM_ARRAY_FIELD_NUMBER
Field Value
Type Description
int

SET_TO_SERVER_VALUE_FIELD_NUMBER

publicstaticfinalintSET_TO_SERVER_VALUE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticPropertyTransformgetDefaultInstance()
Returns
Type Description
PropertyTransform

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticPropertyTransform.BuildernewBuilder()
Returns
Type Description
PropertyTransform.Builder

newBuilder(PropertyTransform prototype)

publicstaticPropertyTransform.BuildernewBuilder(PropertyTransformprototype)
Parameter
Name Description
prototype PropertyTransform
Returns
Type Description
PropertyTransform.Builder

parseDelimitedFrom(InputStream input)

publicstaticPropertyTransformparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
PropertyTransform
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticPropertyTransformparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticPropertyTransformparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
PropertyTransform
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticPropertyTransformparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticPropertyTransformparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
PropertyTransform
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticPropertyTransformparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticPropertyTransformparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PropertyTransform
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticPropertyTransformparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticPropertyTransformparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
PropertyTransform
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticPropertyTransformparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticPropertyTransformparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PropertyTransform
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticPropertyTransformparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyTransform
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<PropertyTransform>parser()
Returns
Type Description
Parser<PropertyTransform>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAppendMissingElements()

publicArrayValuegetAppendMissingElements()

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()

publicArrayValueOrBuildergetAppendMissingElementsOrBuilder()

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()

publicPropertyTransformgetDefaultInstanceForType()
Returns
Type Description
PropertyTransform

getIncrement()

publicValuegetIncrement()

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()

publicValueOrBuildergetIncrementOrBuilder()

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()

publicValuegetMaximum()

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()

publicValueOrBuildergetMaximumOrBuilder()

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()

publicValuegetMinimum()

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()

publicValueOrBuildergetMinimumOrBuilder()

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()

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

getProperty()

publicStringgetProperty()

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()

publicByteStringgetPropertyBytes()

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()

publicArrayValuegetRemoveAllFromArray()

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()

publicArrayValueOrBuildergetRemoveAllFromArrayOrBuilder()

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()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getSetToServerValue()

publicPropertyTransform.ServerValuegetSetToServerValue()

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()

publicintgetSetToServerValueValue()

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()

publicPropertyTransform.TransformTypeCasegetTransformTypeCase()
Returns
Type Description
PropertyTransform.TransformTypeCase

hasAppendMissingElements()

publicbooleanhasAppendMissingElements()

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()

publicbooleanhasIncrement()

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()

publicbooleanhasMaximum()

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()

publicbooleanhasMinimum()

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()

publicbooleanhasRemoveAllFromArray()

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()

publicbooleanhasSetToServerValue()

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()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicPropertyTransform.BuildernewBuilderForType()
Returns
Type Description
PropertyTransform.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedPropertyTransform.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PropertyTransform.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicPropertyTransform.BuildertoBuilder()
Returns
Type Description
PropertyTransform.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.