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

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::DocumentMask

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/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

• #field_paths ⇒ Array<String>

  The list of field paths in the mask.

Instance Method Summary

• #initialize(**args) ⇒ DocumentMask constructor

  A new instance of DocumentMask.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ DocumentMask

Returns a new instance of DocumentMask.

# File 'lib/google/apis/firestore_v1/classes.rb', line 719

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>)

# File 'lib/google/apis/firestore_v1/classes.rb', line 717

def field_paths
  @field_paths
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/firestore_v1/classes.rb', line 724

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