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 document provides reference documentation for the `Field.Types.TtlConfig` class within the Firestore Admin v1 API, detailing its purpose and usage."],["`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."],["The document includes versioned links to the `Field.Types.TtlConfig` for versions 2.2.0 through 3.12.0 of the Firestore Admin V1 API, with 3.12.0 being the most recent version."],["The `Field.Types.TtlConfig` class, inheriting from `object`, implements interfaces like `IMessage`, `IEquatable`, `IDeepCloneable`, and `IBufferMessage`, and has members like `State`."],["The class allows the user to define whether or not there is a state of TTL, where there is a state property that can be altered."]]],[]]
