Enum Field.TtlConfig.State (3.4.2)

Stay organized with collections Save and categorize content based on your preferences.
public enum Field.TtlConfig.State extends Enum<Field.TtlConfig.State> implements ProtocolMessageEnum

The state of applying the TTL configuration to all documents.

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

Implements

ProtocolMessageEnum

Static Fields

NameDescription
ACTIVE

The TTL is active for all documents.

ACTIVE = 2;

ACTIVE_VALUE

The TTL is active for all documents.

ACTIVE = 2;

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

CREATING = 1;

CREATING_VALUE

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

CREATING = 1;

NEEDS_REPAIR

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.

NEEDS_REPAIR = 3;

NEEDS_REPAIR_VALUE

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.

NEEDS_REPAIR = 3;

STATE_UNSPECIFIED

The state is unspecified or unknown.

STATE_UNSPECIFIED = 0;

STATE_UNSPECIFIED_VALUE

The state is unspecified or unknown.

STATE_UNSPECIFIED = 0;

UNRECOGNIZED

Static Methods

NameDescription
forNumber(int value)
getDescriptor()
internalGetValueMap()
valueOf(Descriptors.EnumValueDescriptor desc)
valueOf(int value)

Deprecated. Use #forNumber(int) instead.

valueOf(String name)
values()

Methods

NameDescription
getDescriptorForType()
getNumber()
getValueDescriptor()