public sealed class Field.Types.TtlConfig : IMessage<Field.Types.TtlConfig>, IEquatable<Field.Types.TtlConfig>, IDeepCloneable<Field.Types.TtlConfig>, IBufferMessage, IMessage
Reference documentation and code samples for the Firestore Admin v1 API class Field.Types.TtlConfig.
The TTL (time-to-live) configuration for documents that have this Field
set.
Storing a timestamp value into a TTL-enabled field will be treated as
the document's absolute expiration time. Using any other data type or
leaving the field absent will disable the TTL for the individual document.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the \u003ccode\u003eField.Types.TtlConfig\u003c/code\u003e class within the Firestore Admin v1 API, focusing on its use in setting time-to-live (TTL) configurations for documents.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eTtlConfig\u003c/code\u003e class allows users to manage the expiration of documents by setting a timestamp in a specific field; utilizing a non-timestamp data type in this field, or leaving it blank, will disable TTL for the specific document.\u003c/p\u003e\n"],["\u003cp\u003eThis class implements interfaces such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and its documentation shows the various version history, including the latest version 3.12.0 and down to 2.2.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eTtlConfig\u003c/code\u003e class has two constructors, a default constructor, and one that takes another \u003ccode\u003eTtlConfig\u003c/code\u003e object, as well as a \u003ccode\u003eState\u003c/code\u003e property, which determines the state of the TTL configuration.\u003c/p\u003e\n"]]],[],null,[]]
