Index
Constructors
Methods
Constructors
constructor
-
Creates a FieldPath from the provided field names. If more than one field name is provided, the path will point to a nested field in a document.
Parameters
-
Rest ...fieldNames: string[]
A list of field names.
Returns FieldPath
-
Methods
isEqual
-
Returns true if this
FieldPathis equal to the provided one.Parameters
-
other: FieldPath
The
FieldPathto compare against.
Returns boolean
true if this
FieldPathis equal to the provided one. -
Static documentId
-
Returns a special sentinel
FieldPathto refer to the ID of a document. It can be used in queries to sort or filter by the document ID.Returns FieldPath
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-27 UTC.
A FieldPath refers to a field in a document. The path may consist of a single field name (referring to a top-level field in the document), or a list of field names (referring to a nested field in the document).
Create a FieldPath by providing field names. If more than one field name is provided, the path will point to a nested field in a document.