Uses of Class
com.google.cloud.firestore.DocumentReference

Packages that use DocumentReference

Package	Description
com.google.cloud.firestore

Uses of DocumentReference in com.google.cloud.firestore

Methods in com.google.cloud.firestore that return DocumentReference

Modifier and Type	Method	Description
DocumentReference	CollectionReference.document()	Returns a DocumentReference pointing to a new document with an auto-generated ID within this collection.
DocumentReference	CollectionReference.document(String childPath)	Gets a DocumentReference instance that refers to the document that is a child of this Collection.
DocumentReference	Firestore.document(String path)	Gets a DocumentReference that refers to the document at the specified path.
DocumentReference	BulkWriterException.getDocumentReference()
DocumentReference	CollectionReference.getParent()	Returns a DocumentReference to the containing Document if this is a subcollection, else null.
DocumentReference	DocumentSnapshot.getReference()	Gets the reference to the document.

Methods in com.google.cloud.firestore that return types with arguments of type DocumentReference

Modifier and Type	Method	Description
com.google.api.core.ApiFuture<DocumentReference>	CollectionReference.add(Object pojo)	Adds a new document to this collection with the specified POJO as contents, assigning it a document ID automatically.
com.google.api.core.ApiFuture<DocumentReference>	CollectionReference.add(Map<String,Object> fields)	Adds a new document to this collection with the specified data, assigning it a document ID automatically.
Iterable<DocumentReference>	CollectionReference.listDocuments()	Retrieves the list of documents in this collection.

Methods in com.google.cloud.firestore with parameters of type DocumentReference

Modifier and Type	Method	Description
com.google.api.core.ApiFuture<WriteResult>	BulkWriter.create(DocumentReference documentReference, Object pojo)	Create a document with the provided data.
com.google.api.core.ApiFuture<WriteResult>	BulkWriter.create(DocumentReference documentReference, Map<String,Object> fields)	Create a document with the provided data.
T	UpdateBuilder.create(DocumentReference documentReference, Object pojo)	Creates a new Document at the DocumentReference location.
T	UpdateBuilder.create(DocumentReference documentReference, Map<String,Object> fields)	Creates a new Document at the DocumentReference's location.
com.google.api.core.ApiFuture<WriteResult>	BulkWriter.delete(DocumentReference documentReference)	Delete a document from the database.
com.google.api.core.ApiFuture<WriteResult>	BulkWriter.delete(DocumentReference documentReference, Precondition precondition)	Delete a document from the database.
T	UpdateBuilder.delete(DocumentReference documentReference)	Deletes the document referred to by this DocumentReference.
T	UpdateBuilder.delete(DocumentReference documentReference, Precondition precondition)	Deletes the document referred to by this DocumentReference.
abstract com.google.api.core.ApiFuture<DocumentSnapshot>	Transaction.get(DocumentReference documentRef)	Reads the document referred to by the provided DocumentReference.
com.google.api.core.ApiFuture<List<DocumentSnapshot>>	Firestore.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.
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.
abstract com.google.api.core.ApiFuture<List<DocumentSnapshot>>	Transaction.getAll(DocumentReference... documentReferences)	Retrieves multiple documents from Firestore.
abstract 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.
void	BulkWriter.WriteResultCallback.onResult(DocumentReference documentReference, WriteResult result)
com.google.api.core.ApiFuture<Void>	Firestore.recursiveDelete(DocumentReference reference)	Recursively deletes all documents and subcollections at and under the specified level.
com.google.api.core.ApiFuture<Void>	Firestore.recursiveDelete(DocumentReference reference, BulkWriter bulkWriter)	Recursively deletes all documents and subcollections at and under the specified level.
com.google.api.core.ApiFuture<WriteResult>	BulkWriter.set(DocumentReference documentReference, Object pojo)	Write to the document referred to by the provided DocumentReference.
com.google.api.core.ApiFuture<WriteResult>	BulkWriter.set(DocumentReference documentReference, Object pojo, SetOptions options)	Write to the document referred to by the provided DocumentReference.
com.google.api.core.ApiFuture<WriteResult>	BulkWriter.set(DocumentReference documentReference, Map<String,Object> fields)	Write to the document referred to by the provided DocumentReference.
com.google.api.core.ApiFuture<WriteResult>	BulkWriter.set(DocumentReference documentReference, Map<String,Object> fields, SetOptions options)	Write to the document referred to by the provided DocumentReference.
T	UpdateBuilder.set(DocumentReference documentReference, Object pojo)	Overwrites the document referred to by this DocumentReference.
T	UpdateBuilder.set(DocumentReference documentReference, Object pojo, SetOptions options)	Overwrites the document referred to by this DocumentReference.
T	UpdateBuilder.set(DocumentReference documentReference, Map<String,Object> fields)	Overwrites the document referred to by this DocumentReference.
T	UpdateBuilder.set(DocumentReference documentReference, Map<String,Object> fields, SetOptions options)	Overwrites 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.
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>	BulkWriter.update(DocumentReference documentReference, Precondition precondition, String field, Object value, Object... moreFieldsAndValues)	Update fields of the document referred to by the provided DocumentReference.
com.google.api.core.ApiFuture<WriteResult>	BulkWriter.update(DocumentReference documentReference, String field, Object value, Object... moreFieldsAndValues)	Update fields of the document referred to by the provided DocumentReference.
com.google.api.core.ApiFuture<WriteResult>	BulkWriter.update(DocumentReference documentReference, Map<String,Object> fields)	Update fields of the document referred to by the provided DocumentReference.
com.google.api.core.ApiFuture<WriteResult>	BulkWriter.update(DocumentReference documentReference, Map<String,Object> fields, Precondition precondition)	Update fields of the document referred to by the provided DocumentReference.
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 precondition, FieldPath fieldPath, Object value, Object... moreFieldsAndValues)	Updates the fields in the document referred to by this DocumentReference.
T	UpdateBuilder.update(DocumentReference documentReference, Precondition precondition, String field, Object value, Object... moreFieldsAndValues)	Updates the fields in the document referred to by this DocumentReference.
T	UpdateBuilder.update(DocumentReference documentReference, String field, Object value, Object... moreFieldsAndValues)	Updates the fields in the document referred to by this DocumentReference.
T	UpdateBuilder.update(DocumentReference documentReference, Map<String,Object> fields)	Updates fields in the document referred to by this DocumentReference.
T	UpdateBuilder.update(DocumentReference documentReference, Map<String,Object> fields, Precondition precondition)	Updates fields in the document referred to by this DocumentReference.

Constructors in com.google.cloud.firestore with parameters of type DocumentReference

Modifier	Constructor	Description
	BulkWriterException(io.grpc.Status status, String message, DocumentReference documentReference, com.google.cloud.firestore.BulkWriter.OperationType operationType, int failedAttempts)