Class: Google::Apis::DatastoreV1::PropertyMask

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datastore_v1/classes.rb,
lib/google/apis/datastore_v1/representations.rb,
lib/google/apis/datastore_v1/representations.rb
more...

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PropertyMask

Returns a new instance of PropertyMask.

[View source]

2185
2186
2187
# File 'lib/google/apis/datastore_v1/classes.rb', line 2185

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#pathsArray<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. Corresponds to the JSON property paths

Returns:

  • (Array<String>)

2183
2184
2185
# File 'lib/google/apis/datastore_v1/classes.rb', line 2183

def paths
  @paths
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

2190
2191
2192
# File 'lib/google/apis/datastore_v1/classes.rb', line 2190

def update!(**args)
  @paths = args[:paths] if args.key?(:paths)
end