public abstract class FieldPath extends BasePath<FieldPath> implements Comparable<FieldPath>
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).Constructor and Description |
---|
FieldPath() |
Modifier and Type | Method and Description |
---|---|
static FieldPath |
documentId()
A special sentinel to refer to the ID of a document.
|
static FieldPath |
of(String... fieldNames)
Creates a FieldPath from the provided field names.
|
String |
toString() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
compareTo
public static FieldPath of(@Nonnull String... fieldNames)
fieldNames
- A list of field names.FieldPath
that points to a field location in a document.public static FieldPath documentId()
Copyright © 2019 Google LLC. All rights reserved.