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. Timestamp values in the past
indicate that the document is eligible for immediate expiration. Using any
other data type or leaving the field absent will disable expiration 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 Google Cloud Firestore Admin v1 API, detailing its functionality and implementation across various versions.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eField.Types.TtlConfig\u003c/code\u003e defines the time-to-live (TTL) configuration for documents, allowing for automatic expiration based on timestamp values set in a designated field.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of \u003ccode\u003eField.Types.TtlConfig\u003c/code\u003e is 3.12.0, with a range of previous versions available, starting from 2.2.0, for referencing the different versions' information.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eState\u003c/code\u003e property is an output-only property within the \u003ccode\u003eTtlConfig\u003c/code\u003e class that determines the state of the TTL configuration.\u003c/p\u003e\n"],["\u003cp\u003eThe class \u003ccode\u003eField.Types.TtlConfig\u003c/code\u003e has constructors that allow for the creation of the class.\u003c/p\u003e\n"]]],[],null,[]]
