com.google.cloud.firestore

Class FirestoreBundle.Builder

java.lang.Object

com.google.cloud.firestore.FirestoreBundle.Builder

Enclosing class:

FirestoreBundle

public static final class FirestoreBundle.Builder
extends Object

Builds a Firestore data bundle with results from the given document and query snapshots.

Method Summary

Modifier and Type	Method and Description
FirestoreBundle.Builder	add(DocumentSnapshot documentSnapshot) Adds a Firestore document snapshot to the bundle.
FirestoreBundle.Builder	add(String queryName, QuerySnapshot querySnap) Adds a Firestore query snapshot to the bundle.
FirestoreBundle	build()
String	getId() Returns the ID for this bundle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getId

public String getId()

Returns the ID for this bundle.

add

public FirestoreBundle.Builder add(DocumentSnapshot documentSnapshot)

Adds a Firestore document snapshot to the bundle. Both the document data and the document read time will be included in the bundle.

Parameters:

documentSnapshot - A document snapshot to add.

add

public FirestoreBundle.Builder add(String queryName,
                                   QuerySnapshot querySnap)

Adds a Firestore query snapshot to the bundle. Both the documents in the query snapshot and the query read time will be included in the bundle.

Parameters:

queryName - The name of the query to add.

querySnap - The query snapshot to add.

build

public FirestoreBundle build()