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 reference documentation for the \u003ccode\u003eField.Types.TtlConfig\u003c/code\u003e class within the Firestore Admin v1 API, detailing its structure and functionality.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eField.Types.TtlConfig\u003c/code\u003e manages the time-to-live (TTL) configuration for documents, where setting a timestamp in a TTL-enabled field defines a document's expiration time.\u003c/p\u003e\n"],["\u003cp\u003eThe page includes links to documentation for various versions of the Firestore Admin v1 API, from the latest 3.12.0 down to 2.2.0, with version 3.3.0 being the page's current focus.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eTtlConfig\u003c/code\u003e class implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and has two constructors.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eState\u003c/code\u003e property of the \u003ccode\u003eTtlConfig\u003c/code\u003e class indicates the status of the TTL configuration, which is an output-only property, and it is of the type \u003ccode\u003eField.Types.TtlConfig.Types.State\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]
