Document.TtlMillis
@Documented
@Retention(value = RetentionPolicy.CLASS)
@Target(value = [ElementType.FIELD, ElementType.METHOD])
public annotation Document.TtlMillis
Marks a member field of a document as the document's time-to-live (TTL).
The document will be automatically deleted TtlMillis
milliseconds after CreationTimestampMillis
.
This field is not required. If not present, not set, or set to 0
, the document will never expire or be auto-deleted until the app is uninstalled or removeAsync is called.
If present, the field must be of type long
or Long
.
See the class description of Document
for other requirements (i.e. if present it must be visible, or have a visible getter and setter, or be exposed through a visible constructor).