Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::DocumentMask (v0.12.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::DocumentMask.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#field_paths

def field_paths() -> ::Array<::String>
Returns
  • (::Array<::String>) — The list of field paths in the mask. See Document.fields for a field path syntax reference.

#field_paths=

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