Class FieldMask
An immutable set of field paths, used to limit the data returned by calls to GetAllSnapshotsAsync(IEnumerable<DocumentReference>, CancellationToken) and similar calls.
Implements
Namespace: Google.Cloud.Firestore
Assembly: Google.Cloud.Firestore.dll
Syntax
public sealed class FieldMask : IEquatable<FieldMask>Constructors
FieldMask(params FieldPath[])
Creates a mask from the given paths.
Declaration
public FieldMask(params FieldPath[] paths)Parameters
| Type | Name | Description |
|---|---|---|
| FieldPath[] | paths | The segments of the path. This must not be null, and it must not contain any null elements. |
FieldMask(params string[])
Creates a mask from the given paths. Each path is treated as a dot-separated sequence of field names.
Declaration
public FieldMask(params string[] paths)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | paths | The paths, as dot-separated strings. This must not be null, and it must not contain any null or empty elements. |
Methods
GetHashCode()
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| int |