Package | Description |
---|---|
com.google.cloud.firestore |
Modifier and Type | Method and Description |
---|---|
static FieldPath |
FieldPath.documentId()
A special sentinel to refer to the ID of a document.
|
static FieldPath |
FieldPath.of(String... fieldNames)
Creates a FieldPath from the provided field names.
|
Modifier and Type | Method and Description |
---|---|
boolean |
DocumentSnapshot.contains(FieldPath fieldPath)
Returns whether or not the field exists in the document.
|
Object |
DocumentSnapshot.get(FieldPath fieldPath)
Returns the value at the field or null if the field doesn't exist.
|
static FieldMask |
FieldMask.of(FieldPath... fieldPaths)
Creates a FieldMask from the provided field paths.
|
Query |
Query.orderBy(FieldPath fieldPath)
Creates and returns a new Query that's additionally sorted by the specified field.
|
Query |
Query.orderBy(FieldPath fieldPath,
Query.Direction direction)
Creates and returns a new Query that's additionally sorted by the specified field, optionally
in descending order instead of ascending.
|
Query |
Query.select(FieldPath... fieldPaths)
Creates and returns a new Query instance that applies a field mask to the result and returns
the specified subset of fields.
|
T |
UpdateBuilder.update(DocumentReference documentReference,
FieldPath fieldPath,
Object value,
Object... moreFieldsAndValues)
Updates the fields in the document referred to by this DocumentReference.
|
T |
UpdateBuilder.update(DocumentReference documentReference,
Precondition options,
FieldPath fieldPath,
Object value,
Object... moreFieldsAndValues)
Updates the fields in the document referred to by this DocumentReference.
|
com.google.api.core.ApiFuture<WriteResult> |
DocumentReference.update(FieldPath fieldPath,
Object value,
Object... moreFieldsAndValues)
Updates the fields in the document referred to by this DocumentReference.
|
com.google.api.core.ApiFuture<WriteResult> |
DocumentReference.update(Precondition options,
FieldPath fieldPath,
Object value,
Object... moreFieldsAndValues)
Updates the fields in the document referred to by this DocumentReference.
|
Query |
Query.whereArrayContains(FieldPath fieldPath,
Object value)
Creates and returns a new Query with the additional filter that documents must contain the
specified field, the value must be an array, and that the array must contain the provided
value.
|
Query |
Query.whereEqualTo(FieldPath fieldPath,
Object value)
Creates and returns a new Query with the additional filter that documents must contain the
specified field and the value should be equal to the specified value.
|
Query |
Query.whereGreaterThan(FieldPath fieldPath,
Object value)
Creates and returns a new Query with the additional filter that documents must contain the
specified field and the value should be greater than the specified value.
|
Query |
Query.whereGreaterThanOrEqualTo(FieldPath fieldPath,
Object value)
Creates and returns a new Query with the additional filter that documents must contain the
specified field and the value should be greater than or equal to the specified value.
|
Query |
Query.whereLessThan(FieldPath fieldPath,
Object value)
Creates and returns a new Query with the additional filter that documents must contain the
specified field and the value should be less than the specified value.
|
Query |
Query.whereLessThanOrEqualTo(FieldPath fieldPath,
Object value)
Creates and returns a new Query with the additional filter that documents must contain the
specified field and the value should be less or equal to the specified value.
|
Modifier and Type | Method and Description |
---|---|
static SetOptions |
SetOptions.mergeFieldPaths(List<FieldPath> fields)
Changes the behavior of set() calls to only replace the fields under fieldPaths.
|
Copyright © 2019 Google LLC. All rights reserved.