# Cloud Firestore Admin V1 API - Module Google::Cloud::Firestore::Admin::V1::Field::TtlConfig::State (v1.13.0)

1.13.0 (latest) 1.12.1 1.11.0 1.10.0 1.9.1 1.8.0 1.7.0 1.6.0 1.5.0 1.4.1 1.3.0 1.2.0 1.1.0 1.0.1 0.18.0 0.17.1 0.16.0 0.15.0 0.14.3 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.5 Reference documentation and code samples for the Cloud Firestore Admin V1 API module Google::Cloud::Firestore::Admin::V1::Field::TtlConfig::State.

The state of applying the TTL configuration to all documents.

## Constants

### STATE_UNSPECIFIED

**value:** 0  
The state is unspecified or unknown.

### CREATING

**value:** 1  
The TTL is being applied. There is an active long-running operation to
track the change. Newly written documents will have TTLs applied as
requested. Requested TTLs on existing documents are still being
processed. When TTLs on all existing documents have been processed, the
state will move to 'ACTIVE'.

### ACTIVE

**value:** 2  
The TTL is active for all documents.

### NEEDS_REPAIR

**value:** 3  
The TTL configuration could not be enabled for all existing documents.
Newly written documents will continue to have their TTL applied.
The LRO returned when last attempting to enable TTL for this `Field`
has failed, and may have more details.