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-08-04 UTC."],[[["This document provides reference documentation for the `Field.Types.TtlConfig` class within the Firestore Admin v1 API, detailing its purpose as a time-to-live (TTL) configuration for documents."],["The `Field.Types.TtlConfig` class is used to set the expiration time for documents, with timestamp values in a TTL-enabled field determining the document's absolute expiration."],["The document outlines that `Field.Types.TtlConfig` inherits from `object` and implements interfaces such as `IMessage`, `IEquatable`, `IDeepCloneable`, and `IBufferMessage`, and it also showcases a list of all versions of this file."],["The TTL feature is disabled for any document if a field is left absent or does not contain a timestamp value, according to the documents provided."],["The documentation includes information on the class's constructors, such as `TtlConfig()` and `TtlConfig(TtlConfig other)`, along with details about the `State` property, and shows the versions ranging from 3.12.0 to 2.2.0."]]],[]]
