Class: Google::Cloud::Firestore::V1::DocumentMask

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/common.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 Attribute Details

#field_paths ⇒ ::Array<::String>

Returns The list of field paths in the mask. See Document.fields for a field path syntax reference.

Returns:

  • (::Array<::String>) —

    The list of field paths in the mask. See Document.fields for a field path syntax reference.



33
34
35
36
 
# File 'proto_docs/google/firestore/v1/common.rb', line 33

class DocumentMask
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end