Class FieldPath

An immutable path of field names, used to identify parts of a document.

Inheritance
object
FieldPath
Implements
Inherited Members
Namespace: Google.Cloud.Firestore
Assembly: Google.Cloud.Firestore.dll
Syntax
public sealed class FieldPath : IEquatable<FieldPath>, IComparable<FieldPath>
Remarks

Ordering between field paths is primarily to provide canonical orderings for sets of paths, for example in a FieldMask. This ordering is performed segment-wise, using ordinal string comparisons.

Constructors

FieldPath(params string[])

Creates a path from multiple segments. Each segment is treated verbatim: it may contain dots, which will lead to the segment being escaped in the path's string representation.

Declaration
public FieldPath(params string[] segments)
Parameters
Type Name Description
string[] segments

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

Properties

DocumentId

Sentinel field path to refer to the ID of a document. Used in queries to sort or filter by the document ID.

Declaration
public static FieldPath DocumentId { get; }
Property Value
Type Description
FieldPath

Methods

CompareTo(FieldPath)

Declaration
public int CompareTo(FieldPath other)
Parameters
Type Name Description
FieldPath other
Returns
Type Description
int
Implements

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides