Package | Description |
---|---|
com.google.cloud.firestore |
Modifier and Type | Class and Description |
---|---|
class |
QueryDocumentSnapshot
A QueryDocumentSnapshot contains data read from a document in a Firestore database as part of a
query.
|
Modifier and Type | Method and Description |
---|---|
DocumentSnapshot |
Internal.snapshotFromMap(String documentPath,
Map<String,Object> data) |
DocumentSnapshot |
Internal.snapshotFromObject(String documentPath,
Object pojo) |
DocumentSnapshot |
Internal.snapshotFromProto(com.google.cloud.Timestamp readTime,
Document document) |
Modifier and Type | Method and Description |
---|---|
com.google.api.core.ApiFuture<DocumentSnapshot> |
DocumentReference.get()
Reads the document referenced by this DocumentReference.
|
com.google.api.core.ApiFuture<DocumentSnapshot> |
Transaction.get(DocumentReference documentRef)
Reads the document referred to by the provided DocumentReference.
|
com.google.api.core.ApiFuture<DocumentSnapshot> |
DocumentReference.get(FieldMask fieldMask)
Reads the document referenced by this DocumentReference.
|
com.google.api.core.ApiFuture<List<DocumentSnapshot>> |
Firestore.getAll(DocumentReference... documentReferences)
Retrieves multiple documents from Firestore.
|
com.google.api.core.ApiFuture<List<DocumentSnapshot>> |
Transaction.getAll(DocumentReference... documentReferences)
Retrieves multiple documents from Firestore.
|
com.google.api.core.ApiFuture<List<DocumentSnapshot>> |
Firestore.getAll(DocumentReference[] documentReferences,
FieldMask fieldMask)
Retrieves multiple documents from Firestore, while optionally applying a field mask to reduce
the amount of data transmitted.
|
com.google.api.core.ApiFuture<List<DocumentSnapshot>> |
Transaction.getAll(DocumentReference[] documentReferences,
FieldMask fieldMask)
Retrieves multiple documents from Firestore, while optionally applying a field mask to reduce
the amount of data transmitted from the backend.
|
Modifier and Type | Method and Description |
---|---|
FirestoreBundle.Builder |
FirestoreBundle.Builder.add(DocumentSnapshot documentSnapshot)
Adds a Firestore document snapshot to the bundle.
|
Query |
Query.endAt(DocumentSnapshot snapshot)
Creates and returns a new Query that ends at the provided document (inclusive).
|
Query |
Query.endBefore(DocumentSnapshot snapshot)
Creates and returns a new Query that ends before the provided document (exclusive).
|
Map<String,Value> |
Internal.protoFromSnapshot(DocumentSnapshot snapshot) |
Query |
Query.startAfter(DocumentSnapshot snapshot)
Creates and returns a new Query that starts after the provided document (exclusive).
|
Query |
Query.startAt(DocumentSnapshot snapshot)
Creates and returns a new Query that starts at the provided document (inclusive).
|
Modifier and Type | Method and Description |
---|---|
ListenerRegistration |
DocumentReference.addSnapshotListener(EventListener<DocumentSnapshot> listener)
Starts listening to the document referenced by this DocumentReference.
|
ListenerRegistration |
DocumentReference.addSnapshotListener(Executor executor,
EventListener<DocumentSnapshot> listener)
Starts listening to the document referenced by this DocumentReference.
|
void |
Firestore.getAll(DocumentReference[] documentReferences,
FieldMask fieldMask,
com.google.api.gax.rpc.ApiStreamObserver<DocumentSnapshot> responseObserver)
Retrieves multiple documents from Firestore while optionally applying a field mask to reduce
the amount of data transmitted.
|
void |
Query.stream(com.google.api.gax.rpc.ApiStreamObserver<DocumentSnapshot> responseObserver)
Executes the query and streams the results as a StreamObserver of DocumentSnapshots.
|
Copyright © 2023 Google LLC. All rights reserved.