Class: Google::Apis::FirestoreV1::DocumentMask

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

Overview

A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DocumentMask

Returns a new instance of DocumentMask



467
468
469
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 467

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

Instance Attribute Details

#field_paths ⇒ Array<String>

The list of field paths in the mask. See Document.fields for a field path syntax reference. Corresponds to the JSON property fieldPaths

Returns:

  • (Array<String>) 


465
466
467
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 465

def field_paths
  @field_paths
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



472
473
474
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 472

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