public sealed class DocumentMask : IMessage<DocumentMask>, IEquatable<DocumentMask>, IDeepCloneable<DocumentMask>, IBufferMessage, IMessageReference 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].
Implements
IMessageDocumentMask, IEquatableDocumentMask, IDeepCloneableDocumentMask, IBufferMessage, IMessageNamespace
Google.Cloud.Firestore.V1Assembly
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 |
|