Cloud Datastore V1 Client - Class PropertyMask (1.32.1)

Version latest

• 1.32.1 (latest)
• 1.32.0
• 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 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 message google.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 example foo.bar means the property bar inside the entity property foo inside 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 an array value.

getPaths

The paths to the properties covered by this mask.

A path is a list of property names separated by dots (.), for example foo.bar means the property bar inside the entity property foo inside 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 an array value.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setPaths

The paths to the properties covered by this mask.

A path is a list of property names separated by dots (.), for example foo.bar means the property bar inside the entity property foo inside 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 an array value.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this