# Annotation Type DocumentId (3.43.1)

3.43.1 (latest) 3.41.0 3.38.0 3.37.0 3.36.0 3.35.1 3.33.4 3.32.2 3.31.9 3.30.11 3.28.0 3.27.2 3.26.5 3.25.1 3.24.3 3.22.0 3.21.4 3.20.0 3.17.0 3.16.3 3.15.7 3.14.4 3.13.2 3.12.1 3.11.0 3.10.0 3.9.6 3.8.2 3.7.10 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.1.0 3.0.21

    public interface DocumentId implements Annotation

Annotation used to mark a POJO property to be automatically populated with the document's ID when
the POJO is created from a Cloud Firestore document (for example, via DocumentSnapshot#toObject).

Any of the following will throw a runtime exception:

- This annotation is applied to a property of a type other than String or [DocumentReference](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.DocumentReference).
- This annotation is applied to a property that is not writable (for example, a Java Bean getter without a backing field).
- This annotation is applied to a property with a name that conflicts with a read document field. For example, if a POJO has a field `firstName` annotated by @DocumentId, and there is a property from the document named `firstName` as well, an exception is thrown when you try to read the document into the POJO via DocumentSnapshot#toObject or [DocumentReference#get](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.DocumentReference#com_google_cloud_firestore_DocumentReference_get_).
- 

When using a POJO to write to a document (via [DocumentReference#set](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.DocumentReference#com_google_cloud_firestore_DocumentReference_set_) or @WriteBatch#set), the property annotated by @DocumentId is ignored, which allows writing the POJO
back to any document, even if it's not the origin of the POJO.

## Implements

[Annotation](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html)