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 document provides reference information for the \u003ccode\u003eField.Types.TtlConfig\u003c/code\u003e class within the Firestore Admin v1 API, specifically for the .NET environment, with the latest version being 3.12.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eField.Types.TtlConfig\u003c/code\u003e 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, offering functionalities for message handling, equality comparisons, deep cloning, and buffered message operations.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eTtlConfig\u003c/code\u003e is designed for setting the time-to-live configuration for documents, where a timestamp in a TTL-enabled field determines the document's expiration time, while other data types or absence of data in the field will disable TTL.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eTtlConfig\u003c/code\u003e class has a property called \u003ccode\u003eState\u003c/code\u003e, which is output-only, allowing you to determine the state of the TTL configuration within a field, which it utilizes a Field.Types.TtlConfig.Types.State data type.\u003c/p\u003e\n"],["\u003cp\u003eThere are multiple links that go to each version of the TtlConfig documentation, starting from version 2.2.0 all the way to the latest 3.12.0.\u003c/p\u003e\n"]]],[],null,[]]
