Cloud Firestore V1 Client - Class State (1.31.0)

Version 1.31.0

• 1.47.0 (latest)
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

Reference documentation and code samples for the Cloud Firestore V1 Client class State.

The state of applying the TTL configuration to all documents.

Protobuf type google.firestore.admin.v1.Field.TtlConfig.State

Methods

name

Parameter
Name	Description
value	mixed

value

Parameter
Name	Description
name	mixed

Constants

STATE_UNSPECIFIED

Value: 0

The state is unspecified or unknown.

Generated from protobuf enum STATE_UNSPECIFIED = 0;

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

Generated from protobuf enum CREATING = 1;

ACTIVE

Value: 2

The TTL is active for all documents.

Generated from protobuf enum ACTIVE = 2;

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.

Generated from protobuf enum NEEDS_REPAIR = 3;