GoogleApi.Firestore.V1.Model.DocumentMask (google_api_firestore v0.33.0)

View Source

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.

Attributes

  • fieldPaths (type: list(String.t), default: nil) - The list of field paths in the mask. See Document.fields for a field path syntax reference.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Firestore.V1.Model.DocumentMask{
  fieldPaths: [String.t()] | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.