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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-04-17 UTC."],[[["This webpage provides documentation for the `Field.Types.TtlConfig` class within the Firestore Admin v1 API, focusing on its use in setting time-to-live (TTL) configurations for documents."],["The `TtlConfig` 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."],["This class implements interfaces such as `IMessage`, `IEquatable`, `IDeepCloneable`, and `IBufferMessage`, and its documentation shows the various version history, including the latest version 3.12.0 and down to 2.2.0."],["The `TtlConfig` class has two constructors, a default constructor, and one that takes another `TtlConfig` object, as well as a `State` property, which determines the state of the TTL configuration."]]],[]]