Firestore Admin v1 API - Enum Field.Types.TtlConfig.Types.State (3.7.0)

public enum Field.Types.TtlConfig.Types.State

Reference documentation and code samples for the Firestore Admin v1 API enum Field.Types.TtlConfig.Types.State.

The state of applying the TTL configuration to all documents.

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Fields

NameDescription
Active

The TTL is active for all documents.

Creating

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'.

NeedsRepair

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.

Unspecified

The state is unspecified or unknown.