Reference documentation and code samples for the Cloud Firestore V1 Client class TtlConfig.
The TTL (time-to-live) configuration for documents that have thisFieldset.
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.
Generated from protobuf messagegoogle.firestore.admin.v1.Field.TtlConfig
[[["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-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class TtlConfig (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/Admin.V1.Field.TtlConfig)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/Admin.V1.Field.TtlConfig)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/Admin.V1.Field.TtlConfig)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/Admin.V1.Field.TtlConfig)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/Admin.V1.Field.TtlConfig)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/Admin.V1.Field.TtlConfig)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/Admin.V1.Field.TtlConfig)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/Admin.V1.Field.TtlConfig)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/Admin.V1.Field.TtlConfig)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/Admin.V1.Field.TtlConfig)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/Admin.V1.Field.TtlConfig)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/Admin.V1.Field.TtlConfig)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/Admin.V1.Field.TtlConfig)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/Admin.V1.Field.TtlConfig)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/Admin.V1.Field.TtlConfig)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/Admin.V1.Field.TtlConfig)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/Admin.V1.Field.TtlConfig)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/Admin.V1.Field.TtlConfig)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/Admin.V1.Field.TtlConfig)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/Admin.V1.Field.TtlConfig)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/Admin.V1.Field.TtlConfig)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/Admin.V1.Field.TtlConfig)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/Admin.V1.Field.TtlConfig) \nReference documentation and code samples for the Cloud Firestore V1 Client class TtlConfig.\n\nThe TTL (time-to-live) configuration for documents that have this `Field`\nset.\n\nStoring a timestamp value into a TTL-enabled field will be treated as\nthe document's absolute expiration time. Timestamp values in the past\nindicate that the document is eligible for immediate expiration. Using any\nother data type or leaving the field absent will disable expiration for the\nindividual document.\n\nGenerated from protobuf message `google.firestore.admin.v1.Field.TtlConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ Admin \\\\ V1 \\\\ Field\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getState\n\nOutput only. The state of the TTL configuration.\n\n### setState\n\nOutput only. The state of the TTL configuration."]]
