Firestore API - Class FieldMask (3.9.0) 

public sealed class FieldMask : IEquatable<FieldMask>

Reference documentation and code samples for the Firestore API class FieldMask.

An immutable set of field paths, used to limit the data returned by calls to GetAllSnapshotsAsync(IEnumerable<DocumentReference>, CancellationToken) and similar calls.

Inheritance

object > FieldMask

Implements

IEquatableFieldMask

Namespace

Google.Cloud.Firestore

Assembly

Google.Cloud.Firestore.dll

Constructors

FieldMask(params FieldPath[])

public FieldMask(params FieldPath[] paths)

Creates a mask from the given paths.

Parameter
Name Description
paths FieldPath

The segments of the path. This must not be null, and it must not contain any null elements.

FieldMask(params string[])

public FieldMask(params string[] paths)

Creates a mask from the given paths. Each path is treated as a dot-separated sequence of field names.

Parameter
Name Description
paths string

The paths, as dot-separated strings. This must not be null, and it must not contain any null or empty elements.

Methods

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides