Reference documentation and code samples for the Firestore Admin v1 API enum Index.Types.State.
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.
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.
NeedsRepair
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eIndex.Types.State\u003c/code\u003e enum represents the state of an index within the Firestore Admin v1 API, with possible states including \u003ccode\u003eCREATING\u003c/code\u003e, \u003ccode\u003eNEEDS_REPAIR\u003c/code\u003e, \u003ccode\u003eREADY\u003c/code\u003e, and \u003ccode\u003eUNSPECIFIED\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCREATING\u003c/code\u003e state indicates an index is being built, with a long-running operation in progress and partial data potentially existing.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eNEEDS_REPAIR\u003c/code\u003e signifies that index creation failed, the last long running operation failed, the index is not updated, and there may be some existing index data that might need to be repaired.\u003c/p\u003e\n"],["\u003cp\u003eAn index in the \u003ccode\u003eREADY\u003c/code\u003e state is fully functional, updated with document writes, and completely populated.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version available for the \u003ccode\u003eIndex.Types.State\u003c/code\u003e is \u003ccode\u003e3.12.0\u003c/code\u003e, while the documentation covers versions back to \u003ccode\u003e2.2.0\u003c/code\u003e of the Google Cloud Firestore Admin.V1 API.\u003c/p\u003e\n"]]],[],null,[]]
