public enum Index.State extends Enum<Index.State> implements ProtocolMessageEnum
The state of an index. During index creation, an index will be in the
CREATING
state. If the index is created successfully, it will transition
to the READY
state. If the index creation encounters a problem, the index
will transition to the NEEDS_REPAIR
state.
Protobuf enum google.firestore.admin.v1.Index.State
Implements
ProtocolMessageEnumStatic Fields | |
---|---|
Name | Description |
CREATING | The index is being created. There is an active long-running operation for the index. The index is updated when writing a document. Some index data may exist. |
CREATING_VALUE | The index is being created. There is an active long-running operation for the index. The index is updated when writing a document. Some index data may exist. |
NEEDS_REPAIR | The index was being created, but something went wrong. There is no active long-running operation for the index, and the most recently finished long-running operation failed. The index is not updated when writing a document. Some index data may exist. Use the google.longrunning.Operations API to determine why the operation that last attempted to create this index failed, then re-create the index. |
NEEDS_REPAIR_VALUE | The index was being created, but something went wrong. There is no active long-running operation for the index, and the most recently finished long-running operation failed. The index is not updated when writing a document. Some index data may exist. Use the google.longrunning.Operations API to determine why the operation that last attempted to create this index failed, then re-create the index. |
READY | The index is ready to be used. The index is updated when writing a document. The index is fully populated from all stored documents it applies to. |
READY_VALUE | The index is ready to be used. The index is updated when writing a document. The index is fully populated from all stored documents it applies to. |
STATE_UNSPECIFIED | The state is unspecified. |
STATE_UNSPECIFIED_VALUE | The state is unspecified. |
UNRECOGNIZED |
Static Methods | |
---|---|
Name | Description |
forNumber(int value) | |
getDescriptor() | |
internalGetValueMap() | |
valueOf(Descriptors.EnumValueDescriptor desc) | |
valueOf(int value) | Deprecated. Use #forNumber(int) instead. |
valueOf(String name) | |
values() |
Methods | |
---|---|
Name | Description |
getDescriptorForType() | |
getNumber() | |
getValueDescriptor() |