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 reference documentation for the `Field.Types.TtlConfig` class within the Firestore Admin v1 API, detailing its structure and functionality."],["`Field.Types.TtlConfig` manages the time-to-live (TTL) configuration for documents, where setting a timestamp in a TTL-enabled field defines a document's expiration time."],["The 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."],["The `TtlConfig` class implements several interfaces, including `IMessage`, `IEquatable`, `IDeepCloneable`, and `IBufferMessage`, and has two constructors."],["The `State` property of the `TtlConfig` class indicates the status of the TTL configuration, which is an output-only property, and it is of the type `Field.Types.TtlConfig.Types.State`."]]],[]]
