2.2.0 (latest) 2.0.6 1.34.2 1.33.1 1.32.3 1.31.0 1.30.0 1.29.2 1.28.2 1.26.0 1.25.0 1.24.4 1.23.0 1.22.1 1.21.2 1.19.0 1.18.1 1.17.1 Reference documentation and code samples for the Cloud Datastore V1 Client class PropertyTransform.

A transformation of an entity property.

Generated from protobuf message `google.datastore.v1.PropertyTransform`

## Namespace

Google \\ Cloud \\ Datastore \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ property` | `string` 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. |
| `↳ set_to_server_value` | `int` Sets the property to the given server value. |
| `↳ increment` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.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. |
| `↳ maximum` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.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. |
| `↳ minimum` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.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. |
| `↳ append_missing_elements` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.ArrayValue` 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. |
| `↳ remove_all_from_array` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.ArrayValue` 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. |

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setProperty

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSetToServerValue

Sets the property to the given server value.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [ServerValue](https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.PropertyTransform.ServerValue). |

### hasSetToServerValue

### setSetToServerValue

Sets the property to the given server value.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ServerValue](https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.PropertyTransform.ServerValue). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.Value|null` |   |

### hasIncrement

### setIncrement

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.Value` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.Value|null` |   |

### hasMaximum

### setMaximum

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.Value` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.Value|null` |   |

### hasMinimum

### setMinimum

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.Value` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.ArrayValue|null` |   |

### hasAppendMissingElements

### setAppendMissingElements

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.ArrayValue` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.ArrayValue|null` |   |

### hasRemoveAllFromArray

### setRemoveAllFromArray

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-datastore/latest/V1.ArrayValue` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTransformType

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |