Cloud Firestore Admin V1 API - Module Google::Cloud::Firestore::Admin::V1::Field::TtlConfig::State (v0.18.0)

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.