Reference documentation and code samples for the Cloud Datastore V1 Client class PropertyMask.
The set of arbitrarily nested property paths used to restrict an operation to
only a subset of properties in an entity.
Generated from protobuf messagegoogle.datastore.v1.PropertyMask
Namespace
Google \ Cloud \ Datastore \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ paths
array
The paths to the properties covered by this mask. A path is a list of property names separated by dots (.), for examplefoo.barmeans the propertybarinside the entity propertyfooinside the entity associated with this path. If a property name contains a dot.or a backslash\, then that name must be escaped. A path must not be empty, and may not reference a value inside anarray value.
getPaths
The paths to the properties covered by this mask.
A path is a list of property names separated by dots (.), for examplefoo.barmeans the propertybarinside the entity propertyfooinside
the entity associated with this path.
If a property name contains a dot.or a backslash\, then that
name must be escaped.
A path must not be empty, and may not reference a value inside anarray value.
A path is a list of property names separated by dots (.), for examplefoo.barmeans the propertybarinside the entity propertyfooinside
the entity associated with this path.
If a property name contains a dot.or a backslash\, then that
name must be escaped.
A path must not be empty, and may not reference a value inside anarray value.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Datastore V1 Client - Class PropertyMask (1.33.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.33.1 (latest)](/php/docs/reference/cloud-datastore/latest/V1.PropertyMask)\n- [1.33.0](/php/docs/reference/cloud-datastore/1.33.0/V1.PropertyMask)\n- [1.32.3](/php/docs/reference/cloud-datastore/1.32.3/V1.PropertyMask)\n- [1.31.0](/php/docs/reference/cloud-datastore/1.31.0/V1.PropertyMask)\n- [1.30.0](/php/docs/reference/cloud-datastore/1.30.0/V1.PropertyMask)\n- [1.29.2](/php/docs/reference/cloud-datastore/1.29.2/V1.PropertyMask)\n- [1.28.2](/php/docs/reference/cloud-datastore/1.28.2/V1.PropertyMask)\n- [1.26.0](/php/docs/reference/cloud-datastore/1.26.0/V1.PropertyMask)\n- [1.25.0](/php/docs/reference/cloud-datastore/1.25.0/V1.PropertyMask)\n- [1.24.4](/php/docs/reference/cloud-datastore/1.24.4/V1.PropertyMask)\n- [1.23.0](/php/docs/reference/cloud-datastore/1.23.0/V1.PropertyMask)\n- [1.22.1](/php/docs/reference/cloud-datastore/1.22.1/V1.PropertyMask)\n- [1.21.2](/php/docs/reference/cloud-datastore/1.21.2/V1.PropertyMask)\n- [1.19.0](/php/docs/reference/cloud-datastore/1.19.0/V1.PropertyMask)\n- [1.18.1](/php/docs/reference/cloud-datastore/1.18.1/V1.PropertyMask)\n- [1.17.1](/php/docs/reference/cloud-datastore/1.17.1/V1.PropertyMask) \nReference documentation and code samples for the Cloud Datastore V1 Client class PropertyMask.\n\nThe set of arbitrarily nested property paths used to restrict an operation to\nonly a subset of properties in an entity.\n\nGenerated from protobuf message `google.datastore.v1.PropertyMask`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Datastore \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPaths\n\nThe paths to the properties covered by this mask.\n\nA path is a list of property names separated by dots (`.`), for example\n`foo.bar` means the property `bar` inside the entity property `foo` inside\nthe entity associated with this path.\nIf a property name contains a dot `.` or a backslash `\\`, then that\nname must be escaped.\nA path must not be empty, and may not reference a value inside an\n[array value](/php/docs/reference/cloud-datastore/latest/V1.Value#_Google_Cloud_Datastore_V1_Value__getArrayValue__).\n\n### setPaths\n\nThe paths to the properties covered by this mask.\n\nA path is a list of property names separated by dots (`.`), for example\n`foo.bar` means the property `bar` inside the entity property `foo` inside\nthe entity associated with this path.\nIf a property name contains a dot `.` or a backslash `\\`, then that\nname must be escaped.\nA path must not be empty, and may not reference a value inside an\n[array value](/php/docs/reference/cloud-datastore/latest/V1.Value#_Google_Cloud_Datastore_V1_Value__getArrayValue__)."]]