public final class PropertyTransform extends GeneratedMessageV3 implements PropertyTransformOrBuilder
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
public static final int APPEND_MISSING_ELEMENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INCREMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MAXIMUM_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MINIMUM_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PROPERTY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SET_TO_SERVER_VALUE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static PropertyTransform getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static PropertyTransform.Builder newBuilder()
public static PropertyTransform.Builder newBuilder(PropertyTransform prototype)
public static PropertyTransform parseDelimitedFrom(InputStream input)
public static PropertyTransform parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyTransform parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static PropertyTransform parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PropertyTransform parseFrom(ByteString data)
public static PropertyTransform parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PropertyTransform parseFrom(CodedInputStream input)
public static PropertyTransform parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyTransform parseFrom(InputStream input)
public static PropertyTransform parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyTransform parseFrom(ByteBuffer data)
public static PropertyTransform parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<PropertyTransform> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
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;
public PropertyTransform getDefaultInstanceForType()
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.
|
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;
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.
|
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;
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.
|
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;
public Parser<PropertyTransform> getParserForType()
Overrides
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.
|
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.
|
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.
|
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;
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public PropertyTransform.ServerValue getSetToServerValue()
Sets the property to the given server value.
.google.datastore.v1.PropertyTransform.ServerValue set_to_server_value = 2;
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.
|
public PropertyTransform.TransformTypeCase getTransformTypeCase()
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public PropertyTransform.Builder newBuilderForType()
protected PropertyTransform.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public PropertyTransform.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
