Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::DocumentMask (v1.0.0)

Version 1.0.0

• 1.1.1 (latest)
• 1.1.0
• 1.0.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.8

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.