Package com.google.cloud.firestore.annotation (3.28.0)

GitHub Repository

This package is not the recommended entry point to using this client library!

For this library, we recommend using com.google.cloud.firestore for new applications.

Interfaces

Interface Description
com.google.cloud.firestore.annotation.DocumentId 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:

com.google.cloud.firestore.annotation.Exclude Marks a field as excluded from the Database.
com.google.cloud.firestore.annotation.IgnoreExtraProperties Properties that don't map to class fields are ignored when serializing to a class annotated with this annotation.
com.google.cloud.firestore.annotation.PropertyName Marks a field to be renamed when serialized.
com.google.cloud.firestore.annotation.ServerTimestamp Annotation used to mark a timestamp field as being populated via Server Timestamps. If a POJO being written contains null for a @ServerTimestamp annotated field, it will be replaced with a server-generated timestamp.
com.google.cloud.firestore.annotation.ThrowOnExtraProperties Properties that don't map to class fields when serializing to a class annotated with this annotation cause an exception to be thrown.