Firestore API - Class FieldMask (3.4.0)

Version 3.4.0

• 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.1

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

Inherited Members

object.GetType()

object.ToString()

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

object.GetHashCode()