Firestore v1 API - Class DocumentMask (3.5.1)

Version 3.5.1

• 3.9.0 (latest)
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.5.0
• 2.4.0
• 2.3.0

public sealed class DocumentMask : IMessage<DocumentMask>, IEquatable<DocumentMask>, IDeepCloneable<DocumentMask>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class 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][google.firestore.v1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1.Value].

Inheritance

object > DocumentMask

Implements

IMessageDocumentMask, IEquatableDocumentMask, IDeepCloneableDocumentMask, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

DocumentMask()

public DocumentMask()

DocumentMask(DocumentMask)

public DocumentMask(DocumentMask other)

Parameter
Name	Description
other	DocumentMask

Properties

FieldPaths

public RepeatedField<string> FieldPaths { get; }

The list of field paths in the mask. See [Document.fields][google.firestore.v1.Document.fields] for a field path syntax reference.

Property Value
Type	Description
RepeatedFieldstring