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 |
---|---|
static Filter |
Filter.arrayContains(FieldPath fieldPath,
Object value)
Creates a new filter for checking that the given array field contains the given value.
|
static Filter |
Filter.arrayContainsAny(FieldPath fieldPath,
Object value)
Creates a new filter for checking that the given array field contains any of the given values.
|
boolean |
DocumentSnapshot.contains(FieldPath fieldPath)
Returns whether or not the field exists in the document.
|
static Filter |
Filter.equalTo(FieldPath fieldPath,
Object value)
Creates a new filter for checking that the given field is equal to the given value.
|
Object |
DocumentSnapshot.get(FieldPath fieldPath)
Returns the value at the field or null if the field doesn't exist.
|
<T> T |
DocumentSnapshot.get(FieldPath fieldPath,
Class<T> valueType)
Returns the value at the field, converted to a POJO, or null if the field or document doesn't
exist.
|
static Filter |
Filter.greaterThan(FieldPath fieldPath,
Object value)
Creates a new filter for checking that the given field is greater than the given value.
|
static Filter |
Filter.greaterThanOrEqualTo(FieldPath fieldPath,
Object value)
Creates a new filter for checking that the given field is greater than or equal to the given
value.
|
static Filter |
Filter.inArray(FieldPath fieldPath,
Object value)
Creates a new filter for checking that the given field equals any of the given values.
|
static Filter |
Filter.lessThan(FieldPath fieldPath,
Object value)
Creates a new filter for checking that the given field is less than the given value.
|
static Filter |
Filter.lessThanOrEqualTo(FieldPath fieldPath,
Object value)
Creates a new filter for checking that the given field is less than or equal to the given
value.
|
static Filter |
Filter.notEqualTo(FieldPath fieldPath,
Object value)
Creates a new filter for checking that the given field is not equal to the given value.
|
static Filter |
Filter.notInArray(FieldPath fieldPath,
Object value)
Creates a new filter for checking that the given field does not equal any of the given values.
|
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.
|
com.google.api.core.ApiFuture<WriteResult> |
BulkWriter.update(DocumentReference documentReference,
FieldPath fieldPath,
Object value,
Object... moreFieldsAndValues)
Update fields of the document referred to by the provided
DocumentReference . |
T |
UpdateBuilder.update(DocumentReference documentReference,
Precondition precondition,
FieldPath fieldPath,
Object value,
Object... moreFieldsAndValues)
Updates the fields in the document referred to by this DocumentReference.
|
com.google.api.core.ApiFuture<WriteResult> |
BulkWriter.update(DocumentReference documentReference,
Precondition precondition,
FieldPath fieldPath,
Object value,
Object... moreFieldsAndValues)
Update fields of the document referred to by the provided
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.whereArrayContainsAny(FieldPath fieldPath,
List<? extends Object> values)
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 at least one value
from the provided list.
|
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.whereIn(FieldPath fieldPath,
List<? extends Object> values)
Creates and returns a new Query with the additional filter that documents must contain the
specified field and the value must equal one of the values from the provided list.
|
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.
|
Query |
Query.whereNotEqualTo(FieldPath fieldPath,
Object value)
Creates and returns a new Query with the additional filter that documents must contain the
specified field and the value does not equal the specified value.
|
Query |
Query.whereNotIn(FieldPath fieldPath,
List<? extends Object> values)
Creates and returns a new Query with the additional filter that documents must contain the
specified field and the value does not equal any of the values from the provided list.
|
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 © 2023 Google LLC. All rights reserved.