Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::PropertyMask (v1.5.0)

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::PropertyMask.

The set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#paths

def paths() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#paths=

def paths=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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
  • (::Array<::String>) — 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.